Abrufen des Standardquellsystems zu einem d.3-Repository
Freigegeben: JSON-Repräsentation
Das Standardquellsystem ist ein vordefiniertes Quellsystem pro d.3-Repository, das standardmäßig von der DMSApp bereitgestellt wird. Wenn Sie eine Erweiterung zu DMS-Funktionalitäten bereitstellen und kein eigenes Quellsystem definieren möchten, können Sie mit dem Standardquellsystem die Eigenschaften und Kategorien des d.3-Repositorys verwenden.
Die Definition eines Standardquellsystems und die zugehörigen Zuordnungen werden von der DMSApp festgelegt. Sie können Zuordnungen zu einem Standardquellsystem nicht ändern.
In diesem Kapitel erfahren Sie, wie Sie die Quellsystemdefinition je d.3-Repository abrufen können.
Um die Quellsystemdefinition eines d.3-Repositorys abzurufen, müssen Sie folgende Schritte durchführen:
Ermitteln der URL zu einem Repository
Ermitteln der Linkrelation zum Abrufen der Quellsystemdefinition eines d.3-Repositorys
Aufrufen der URL für die Quellsystemdefinition eines d.3-Repositorys
Ermitteln der URL zu einem Repository
Im Kapitel Ermitteln eines Repositorys können Sie nachlesen, wie Sie die URL zu einem Repository ermitteln.
Ermitteln der Linkrelation zum Abrufen der Quellsystemdefinition eines d.3-Repositorys
Das JSON-Objekt zu einem d.3-Repository enthält die Linkrelation source
, mit deren Hilfe Sie die Quellsystemdefinition des d.3-Repositorys abrufen können.
Response
{ "_links": { "source": { "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/source" } }, "id": "dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27" }
Aufrufen der URL für die Quellsystemdefinition eines d.3-Repositorys
Sie müssen sicherstellen, dass Sie sich für das d.3-Repository authentifizieren können. Nur dann können Sie die URL abrufen. Das Standardquellsystem enthält alle Kategorien und Eigenschaften des d.3-Repositorys unabhängig von den Berechtigungen des Benutzers.
Rufen Sie die Quellsystemdefinition des d.3-Repositorys mit der zuvor ermittelten URL wie folgt ab:
Request
GET https://host/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/source HTTP/1.1 Accept: application/hal+json
Response
HTTP/1.1 200 OK Content-Type: application/hal+json { "id": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/source", "displayName": "D3RepositoryName", "properties": [ { "key": "Key0", "type": "String", "displayName": "Sample property1" } ], "categories":[ { "key": "mycategory1_ID", "displayName": "Sample category1" } ] }
Struktur einer Quelle
Eigenschaft | Beschreibung |
---|---|
| Gibt den eindeutigen Bezeichner des Standardquellsystems an. Diese ID verwenden Sie als Wert zum Parameter |
| Gibt den Anzeigenamen eines d.3-Repositorys an. |
| Gibt das Array der Kategorien des abgefragten Quellsystems an. |
| Gibt das Array der Eigenschaften des abgefragten Quellsystems an. |
Struktur einer Kategorie
Eigenschaft | Beschreibung |
---|---|
| Gibt den eindeutigen Bezeichner der Kategorie im Quellsystem an. |
| Gibt den Anzeigenamen der Kategorie an. Mit Blick auf die Internationalisierung arbeitet die DMSApp mit dem HTTP-Header |
Struktur einer Eigenschaft
Eigenschaft | Beschreibung |
---|---|
| Gibt den eindeutigen Bezeichner der Eigenschaft im Quellsystem an. |
| Gibt den Typ der Eigenschaft zurück. Der Typ der Eigenschaft wird vom Administrator beim Erstellen der Eigenschaft definiert. Mögliche Werte sind: String, ColorCode, Date, DateTime, Double, Money. |
| Gibt den Anzeigenamen der Eigenschaft an. Die DMSApp arbeitet zur Internationalisierung mit dem HTTP-Header |