EntitiesListOptionalParams interface

Gibt an, ob die Anforderung Caches verwenden soll. Füllen Sie den Header mit dem Wert "no-cache" auf, um vorhandene Caches zu umgehen.

cacheControl?: string

Eigenschaftswert

Mit dem Filterparameter können Sie nach den Namen- oder Anzeigenamenfeldern filtern. Sie können die Gleichheit des Namensfelds (z. B. name eq '{entityName}') überprüfen und nach Teilzeichenfolgen für den Namen oder anzeigenamen(z. B. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')) suchen. Beachten Sie, dass die Felder "{entityName}" und "{substringToSearch}" die Groß-/Kleinschreibung nicht beachtet werden.

filter?: string

Eigenschaftswert

Ein Filter, der es dem Abrufen von Entitäten ermöglicht, sich auf eine bestimmte Gruppe zu konzentrieren (d. h. "$filter=name eq 'groupName'")

groupName?: string

Eigenschaftswert

Der $search-Parameter wird in Verbindung mit dem parameter $filter verwendet, um je nach übergebenen Parameter drei verschiedene Ausgaben zurückzugeben. Mit $search=AllowedParents gibt die API die Entitätsinformationen aller Gruppen zurück, denen die angeforderte Entität gemäß den Berechtigungen des Benutzers erneut zur Seite gestellt werden kann. Mit $search=AllowedChildren gibt die API die Entitätsinformationen aller Entitäten zurück, die als untergeordnete Elemente der angeforderten Entität hinzugefügt werden können. Mit $search=ParentAndFirstLevelChildren gibt die API die übergeordnete und erste Ebene von untergeordneten Elementen zurück, auf die der Benutzer über einen der untergeordneten Elemente direkten Oder indirekten Zugriff hat. Mit $search=ParentOnly gibt die API nur die Gruppe zurück, wenn der Benutzer Zugriff auf mindestens einen der Nachfolger der Gruppe hat. Mit $search=ChildrenOnly gibt die API nur die erste Ebene der untergeordneten Elemente der Gruppenentitätsinformationen zurück, die in $filter angegeben sind. Der Benutzer muss direkten Zugriff auf die untergeordneten Entitäten oder einen untergeordneten Benutzer haben, damit er in den Ergebnissen angezeigt wird.

search?: string

Eigenschaftswert

Dieser Parameter gibt die Felder an, die in die Antwort eingeschlossen werden sollen. Kann eine beliebige Kombination aus Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, z. B. '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain', enthalten. Wenn der parameter $select angegeben wird, kann die Auswahl in $skipToken außer Kraft setzen.

select?: string

Eigenschaftswert

Anzahl der Entitäten, die beim Abrufen von Ergebnissen übersprungen werden sollen. Wenn Sie dies übergeben, werden $skipToken außer Kraft setzen.

skip?: number

Eigenschaftswert

Seitenfortsetzungstoken wird nur verwendet, wenn ein vorheriger Vorgang ein Teilergebnis zurückgegeben hat. Wenn eine vorherige Antwort ein nextLink-Element enthält, enthält der Wert des nextLink-Elements einen Tokenparameter, der einen Ausgangspunkt angibt, der für nachfolgende Aufrufe verwendet werden soll.

skiptoken?: string

Eigenschaftswert

Anzahl der Elemente, die beim Abrufen von Ergebnissen zurückgegeben werden sollen. Wenn Sie dies übergeben, werden $skipToken außer Kraft setzen.

top?: number

Eigenschaftswert

Der Ansichtsparameter ermöglicht Clients das Filtern des Datentyps, der vom getEntities-Aufruf zurückgegeben wird.

view?: string

Eigenschaftswert

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

abortSignal?: AbortSignalLike

Eigenschaftswert

Geerbt von coreClient.OperationOptions.abortSignal

Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.

onResponse?: RawResponseCallback

Eigenschaftswert

Geerbt von coreClient.OperationOptions.onResponse

Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.

requestOptions?: OperationRequestOptions

Eigenschaftswert

Geerbt von coreClient.OperationOptions.requestOptions

Optionen zum Außerkraftsetzen des Serialisierungs-/De serialisierungsverhaltens.

serializerOptions?: SerializerOptions

Eigenschaftswert

Geerbt von coreClient.OperationOptions.serializerOptions

Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

tracingOptions?: OperationTracingOptions

Eigenschaftswert

Geerbt von coreClient.OperationOptions.tracingOptions