Ermitteln eines Repositorys
Freigegeben: JSON-Repräsentation
Sie benötigen für die Implementierung eigener Funktionen immer die ID des Repositorys. Mit der DMSApp haben Sie die Möglichkeit, auf unterschiedliche Repositorys zuzugreifen, wenn Sie in Ihrem Unternehmen oder Ihrer Organisation mehrere Repositorys konfiguriert haben.
Wenn Sie beispielsweise, einen Suchvorgang starten möchten, müssen Sie erst ein Repository auswählen. Um das Repository anzugeben, führen Sie eine HTTP GET
-Anforderung für die REST-Ressource /dms
aus.
Das Ermitteln der Repository-ID erfolgt in zwei Schritten:
Ermitteln der Linkrelation zum Abrufen der Liste der Repositorys
Abrufen der Liste der Repositorys
Ermitteln der Linkrelation zum Abrufen der Liste der Repositorys
Die URL für ein Repository ist als Linkrelation in der Antwort (Response) der HTTP GET
-Anforderung verfügbar.
Request
GET /dms Accept: application/hal+json
Response
{ _links: { repo: { href: "/dms/r/{repositoryid}", templated: true } } }
Abrufen der Liste der Repositorys
Um repositoryspezifische Funktionen aufrufen zu können, benötigen Sie die Repository-ID.
Ersetzen Sie den Platzhalter {repositoryid}
in der URL "/dms/r/{repositoyid}"
mit der Repository-ID. Wenn Sie die Repository-ID nicht kennen, rufen Sie die URL /dms/r
wie folgt auf:
Request
GET /dms/r Accept: application/hal+json
In der Antwort erhalten Sie ein Array von Repositorys, bei dem jeweils die Repository-ID als Eigenschaft id
und der Anzeigename des Repositorys als Eigenschaft name
aufgeführt ist.
Response
{ repositories: [ { id: "dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27", name: "Contoso (A)" }, ... ] }
Wenn Sie die Repository-ID bereits kennen, dann können Sie den Platzhalter {repositoryid}
in der URL /dms/r/{repositoryid}
mit der Repository-ID ersetzen. Wenn Sie URL mit der Repository-ID aufrufen, erhalten Sie folgendes Ergebnis:
Request
GET /dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27 Accept: application/hal+json
Das JSON-Objekt in der Antwort ist dasselbe Objekt wie in der Liste der JSON-Objekte aus der Anforderung zur URL /dms/r
.
Response
{ id: "dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27", name: "Contoso (A)" }