Resources
speccustomimplcandidateBereitstellung und Verwaltung von Datei-Ressourcen.
Umfang
Typische Dateiressourcen sind Ressourcen, die von Styles referenziert werden (Icons, Sprites) oder Schemadokumente, die aus Daten referenziert werden. Die Dateien befinden sich im Ordner api-resources/resources/{apiId}.
Operationen
| Ressource | Pfad | Methoden | Formate | Beschreibung |
|---|---|---|---|---|
Resources | resources | GET | HTML, JSON | Die Operation ruft die Liste der Dateiressourcen in der API ab. Für jede Ressource werden die ID und ein Link zur Datei angegeben. |
Resource | resources/{resourceId} | GET | Any | Holt die Dateiressource mit dem Bezeichner resourceId. Die Menge der verfügbaren Ressourcen kann unter /resources abgerufen werden. |
Resource | resources/{resourceId} | DELETE, PUT | Any | Erzeugen, Aktualisieren oder Löschen einer Dateiressource. |
Pfad-Parameter
| Name | Ressourcen | Beschreibung |
|---|---|---|
resourceId | Resource | Der lokale Identifikator der Dateiressource. |
Query Parameter
| Name | Ressourcen | Beschreibung |
|---|---|---|
f | Resources | Wählt das Ausgabeformat der Antwort. Wenn kein Wert angegeben wird, gelten die Standard-HTTP Regeln, d.h. der "Accept"-Header wird zur Bestimmung des Formats verwendet. |
Konfiguration
Optionen
| Name | Default | Beschreibung | Typ | Seit |
|---|---|---|---|---|
buildingBlock | Immer RESOURCES. | string | v3.1 | |
enabled | false | Soll der Baustein aktiviert werden? | boolean | v3.1 |
caching | {} | Setzt feste Werte für HTTP-Caching-Header für die Ressourcen. | object | v3.1 |
managerEnabled | false | Steuert, ob die Ressourcen über PUT und DELETE über die API erzeugt und gelöscht werden können sollen. | boolean | v3.1 |
Beispiele
- buildingBlock: RESOURCES
enabled: true
managerEnabled: true