→ "Try it out - API Component "YADB"
→ check GitHub Python calls | Java Script calls | Java calls | Postman collection
[Objects] | [Schema] | [Versioning]
| GET | Get document metadata by ID |
... returns the metadata related to the document (object) that matches the objectId parameter..../dms-core/objects/{objectId}→ Python call | Java Script call | Java call |
| POST | Update document metadata by ID |
... updates the metadata of the document (object) that matches the objectId path parameter.
To update the metadata send the request with the new metadata as request body and the ID of the document (object) as objectId. If one of the properties is missing in the new metadata, it will be removed from the document (object). .../dms-core/objects/{objectId}→ Python call | Java Script call | Java call |
| PATCH | Patch Update document metadata by ID |
... updates only the values of the metadata properties included in the request body of the document (object) that matches the objectId path parameter.
To update the metadata send the request with the new metadata as request body and the ID of the document (object) as objectId. A property value can be removed by sending null as the new value. .../dms-core/objects/{objectId}→ Python call | Java Script call | Java call |
| DEL | Delete document by ID |
... deletes the document (object) that matches the given objectId parameter..../dms-core/objects/{objectId}→ Python call | Java Script call | Java call |
| GET | Validate content digest by ID |
... validates the content digest for a stored document. Send a request with the objectId which generates a new content digest based on the currently stored document. This newly generated content digest is compared with the formerly generated and stored one.
For already imported documents, using the "Store one or more documents" endpoint, a content digest is automatically generated and stored (Secure Hash Algorythm, SHA256) .../dms-core/objects/{objectId}/actions/validate/digest→ Python call | Java Script call | Java call |
| GET | Get document content by ID |
... returns the original content file of the document (object) that matches the objectId parameter..../dms-core/objects/{objectId}/contents/file→ Python call | Java Script call | Java call |
| POST | Update document content by ID |
... updates the content file of the document (object) that matches the objectId parameter.
You can name the content by passing the file name over to the Content-Disposition header. .../dms-core/objects/{objectId}/contents/file→ Python call | Java Script call | Java call |
| GET | Get a list of history entries by ID |
... retrieves information about the actions and modifications that have been carried out for the given document (object) - objectId parameter. Each action or modification is stored in a separate history entry..../dms-core/objects/{objectId}/history→ Python call | Java Script call | Java call |
| GET | Get document metadata by ID (specified version) |
... returns the metadata of the version matching the versionNr parameter of the document (object) that matches the objectId parameter..../dms-core/objects/{objectId}/versions/{versionNr}→ Python call | Java Script call | Java call |
| DEL | Delete document by ID (specified version) |
... deletes the version matching the versionNr parameter of the document (object) that matches the objectId parameter..../dms-core/objects/{objectId}/versions/{versionNr}→ Python call | Java Script call | Java call |
| GET | Get document content by ID (specified version) |
... returns the content of the version matching the versionNr parameter of the document (object) that matches the objectId parameter..../dms-core/objects/{objectId}/versions/{versionNr}/contents/file→ Python call | Java Script call | Java call |
| GET | Validate content digest by ID (specified version) |
... validates the content digest of the version matching the versionNr parameter of the document (object) that matches the objectId parameter..../dms-core/objects/{objectId}/versions/{versionNr}/actions/validate/digest→ Python call | Java Script call | Java call |
| POST | Store one or more documents | ... requires a multipart body with a metadata parameter as well as a binary content parameter.
Save your metadata as file (e.g. metadata.json) and use it for the data parameter. For the binary content, the cid_63apple parameter, you can use any file you'd like to store. If the request is successful, the metadata of the previously stored document will be returned in JSON format. ...
/dms-core/objects→ Python call | Java Script call | Java call |
| POST | Search documents by search query |
... requires a JSON body containing your search query.
The search parameters skipCount and maxItems allow paging for search queries, whereby maxItems defines the maximum number of entries in the hit list and skipCount the maximum number of entries to be skipped. .../dms-core/objects/search→ Python call | Java Script call | Java call |
| GET | Applied tenant schema | ... returns the applied schema of the tenant (JSON / XML) belonging to you as the logged on user. The applied schema is the tenant schema, enhanced by the global schema and the system properties..../dms-core/schema/native→ Python call | Java Script call | Java call |
| GET | Get document metadata by ID (specified version) |
... returns the metadata of the version matching the versionNr parameter of the document (object) that matches the objectId parameter..../dms-core/objects/{objectId}/versions/{versionNr}→ Python call | Java Script call | Java call |
| DEL | Delete document by ID (specified version) |
... deletes the version matching the versionNr parameter of the document (object) that matches the objectId parameter..../dms-core/objects/{objectId}/versions/{versionNr}→ Python call | Java Script call | Java call |
| GET | Get document content by ID (specified version) |
... returns the content of the version matching the versionNr parameter of the document (object) that matches the objectId parameter..../dms-core/objects/{objectId}/versions/{versionNr}/contents/file→ Python call | Java Script call | Java call |
| GET | Validate content digest by ID (specified version) |
... validates the content digest of the version matching the versionNr parameter of the document (object) that matches the objectId parameter..../dms-core/objects/{objectId}/versions/{versionNr}/actions/validate/digest→ Python call | Java Script call | Java call |