"list"-APIs aufrufen

Greifen Sie mit GET-HTTP-Anforderungen auf "list"-APIs zu. "list"-APIs geben eine Liste von Datensätzen zurück, die den Kriterien entsprechen, die in den Anforderungsparametern angegeben sind.

REST-Listenanforderungen verwenden getNameList -APIs, wobei Name der Typ der Ressource ist, die Sie in der Anforderung angeben. Die vollständige Liste von Ressourcen und APIs finden Sie in den REST-Javadoc-Dateien.

Anforderungsformat

Verwenden Sie das HTTP-Anforderungsformat zum Aufrufen von "list"-APIs:

GET https://host:port/contextRoot/restapi/Name?parameters

Das folgende Beispiel zeigt einen REST-Aufruf von getOrganizationList an:

GET https://host:port/contextRoot/restapi/organization?IsNode=Y&OrganizationName=~like~DEMO

Abfragefilterung

In einem REST-API-Aufruf zum Auflisten ("list") können Sie Ergebnisse nach den Parametern "attribut"/"wert" filtern, die in der Abfrage angegeben sind. Im Beispiel getOrganizationList sind IsNode=Y und OrganizationName=~like~DEMO diese Parameter "attribut"/"wert". "attribut"/"wert"-Parameter sind in der Anforderungs-URL durch Et-Zeichen (&) voneinander getrennt.

Sie können die Beziehung zwischen Attributen und ihren Werten mithilfe der folgenden Formatierungsoptionen angeben:

Format	Beschreibung
`attribute=value`	`attribut` ist gleich `wert`.
`attribute=~neq~value`	`attribut` ist nicht gleich `wert`.
`attribute=~gt~value`	`attribut` ist größer als `wert`.
`attribute=~gteq~value`	`attribut` ist größer oder gleich `wert`.
`attribute=~lt~value`	`attribut` ist kleiner als `wert`.
`attribute=~lteq~value`	`attribut` ist kleiner oder gleich `wert`.
`attribute=~ew~value`	`attribut` endet mit `wert`.
`attribute=~sw~value`	`attribut` beginnt mit `wert`.
`attribute=~like~value`	`attribut` ist gleich `wert`.

Ergebnisse sortieren

Zum Anordnen von Antwortdaten in einer durch bestimmte Attribute angegebenen Reihenfolge übergeben Sie den Parameter sort und die Attribute, nach denen Sie in der Anforderungs-URL sortieren möchten:

sort({+ or -}attribute1,{+ or -}attribute2)

+ Aufsteigend sortieren
- In absteigender Reihenfolge sortieren

Das folgende Beispiel zeigt einen REST-Aufruf von getOrganizationList, wobei die Sortierfunktion als Parameter übergeben wird:

GET /restapi/organization?sort(+OrganizationName,-Createts)

Alternativ können Sie den Parameter _sort in URL übergeben, wenn die Anforderungsparameter das Format attribute=value haben sollen. Das folgende Beispiel zeigt das Format einer identischen Sequenzanforderung, die den Parameter _sort verwendet.

GET /restapi/organization?_sort=+OrganizationName,-Createts

Seitenaufteilung

Die Paginierung wird durch den HTTP-Header Range gesteuert. Indem Sie beispielsweise einen Header Range mit dem Wert items=20-39 angeben, wird der 20. bis 39. Artikel aus der Abfrage zurückgegeben.

Alternativ können Sie den Parameter _range in der Anforderungs-URL übergeben. Verwenden Sie diese Option, wenn Probleme mit dem Header Range auftreten:

GET /restapi/organization?_range=20-39