The following endpoints are provided by the Content REST API.
Note: To make calls to the Content REST API, you must
include the URL of the Hyland Content repository directly before the endpoint in your
request. In this guide's tutorials, this URL is represented by the
[base_url] placeholder in sample requests (for example, GET
[base_url]/hello/protected). However, in this guide's reference topics, the
[base_url] placeholder is omitted for simplicity (for example,
GET /hello/protected).
| API Name | Main Endpoint | Description |
|---|---|---|
| Bulk Import | /api/import | Allows administrators to perform CRUD operations on bulk import jobs in the repository. |
| CheckIn | /api/documents/[docId]/checkin | Checks in the working copy of a document to create a version of that document. |
| Copy | /api/documents/[docId]/copy | Copies the source document inside the destination folder. |
| Document | /api/documents/path[docPath] | Allows CRUD operations on documents in the repository. |
| Document Permissions | /api/documents/[docId] | Returns the effective ACLs and list of effective permissions on documents in the repository. |
| Download | /api/documents/[docId]/[propertyXPathAndFilename] | Returns the document blob and related information. |
| Greeting | /hello | Returns greeting messages for simple testing purposes. |
| Group | /api/group | Returns groups matching the given search parameters. |
| Model | /api/repository/model | Allows CRUD operations on the content model in the repository. |
| Move | /api/documents/[docId]/move | Moves the source document to a provided destination. |
| Query | /api/query | Returns search results. |
| Rendition Configurations | /api/repository/renditions/project/[projectId] | Updates the configuration of renditions that are specific to projects in the content model. |
| Renditions | /api/documents/[docId]/renditions | Allows CRUD operations on renditions of the given document. |
| Security | /api/repository/security/policies | Allows retrieve, update, and patch operations on security policies in the repository. |
| Upload | /api/upload | Allows CRUD operations on file uploads. |
| User | /api/user | Returns users matching the given search parameters. |
| Version | /api/documents/[versionId]/restore | Restores a document from the given version. |
| Vocabulary | /api/vocabularies | Allows CRUD operations on vocabularies. |