...
- Set-up yuuvis® API system (see minikube setup, for example Installation Guide)
A user with at least read permissions on a document type in the system (see tutorial for permissions) - Simple Maven project
...
The direct access to a document takes place via its object ID via GET request to the endpoint /api/dms/objects/{objectId}
. The objectId
serves as a unique identifier of a document and can be obtained from the response of the API call of an import (see Tutorial for updating documents: Determining the objectId after import).
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
String objectId = "1234567890"; //example-objectId Request metadataRequest = new Request.Builder() .header("Authorization", "Basic " + auth) .header("X-ID-TENANT-NAME", tenant) .url(baseUrl+ "/api/dms/objects/" + objectId) .get().build(); Response metadataResponse = client.newCall(metadataRequest).execute(); String metadataResponseString = metadataResponse.body().string(); |
...
If a specific version of the document is to be requested, the endpoint to be called for the documents' metadata changes to /api/dms/objects/{objectId}/versions/{versionNr}
and for the documents' content to /api/dms/objects/{objectId}/versions/{versionNr}/contents/file
. More about this topic can be found in the Updating Documents via Core API tutorial tutorial under Versioning.
Retrieving Documents via Search Endpoint
...
Info | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||
More Tutorials
|
...