Document Store » Development » REST API
This section describes the REST API for the EInnovaetor Document Store.
Client applications are recommend to use one of the provided client libraries for the select language (a.k.a. language bindings)
as this simplifies and accelerates development. For apps developed in a languages for which there is no provided language binding (commercially supported or community contributed) or for which an alternative API is preferred
the REST API specification described here can be used as reference for guide new client library implementations.
Data Model
- Document — Generic abstraction for storage object managed by the server
includes:- File — with content (down-loadable payload) and meta-data
- Folder — a list of Documents (a.k.a. Directories)
- Link — a link or reference to other Document (a.k.a. Symbolic Link)
- Authority — A permission assigned to a user or group for perform actions on a specific Document
- Mount — A storage device or service attached to a integrated document tree
Support Data Model
- DocumentFilter — A filter for Documents
- DocumentOptions — Document retrieval options
- RequestOptions — Document write operation options
- PageOptions — Pagination Options
Documents Endpoints
This section describes endpoints for Document management.
Table below provides a quick summary:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
GET | /api/__/{**:path} | DocumentFilter PageOptions | OK NOT_FOUND | list | List Documents in Folder | |||
GET | /api/_meta/{**:path} | DocumentOptions | Document | meta | Get Document Meta Details | |||
POST | /api/_copy/{**:path} | DocumentOptions | copy | Copy Document | ||||
POST | /api/_mkdir/{**:path} | Document DocumentOptions | mkdir | Make Folder | ||||
POST | /api/_rename/{**:path} | DocumentOptions | rename | Rename Document | ||||
POST | /api/_move/{**:path} | DocumentOptions | move | Move Document | ||||
POST | /api/_move | DocumentOptions | moveMany | Move Document | ||||
DELETE | /api/_/{**:path} | DocumentOptions | NO_CONTENT | delete | Delete document | |||
DELETE | /api/_rm | DocumentOptions | path[] | NO_CONTENT | deleteMany | Delete Many Documents | ||
POST | /api/_restore/{**:path} | DocumentOptions | NO_CONTENT | restore | Restore Document | |||
POST | /api/_sharing/{**:path} | ShareType DocumentOptions | NO_CONTENT | setSharing | Update Sharing settings for Document | |||
POST | /api/_comment/{**:path} | DocumentOptions | enableComments | Enable Comments for Document | ||||
DELETE | /api/_attachment/{**:path} | DocumentOptions | deleteAttachment | |||||
POST | /api/_create/{**:path} | Document DocumentOptions | CREATED | create |
Authority Endpoints
This section describes endpoints for Document specific Authorities.
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
GET | /api/_auth/{**:path} | DocumentOptions | Authority[] | OK | listAuthorities | Get Authorities for Document | ||
DELETE | /api/_auth/{**:path} | DocumentOptions | id[] | NO_CONTENT | deleteManyAuthority | Delete Many Authorities | ||
POST | /api/_auth/ | DocumentOptions | resendInvite | Resend Authority Invite | ||||
GET | /api/_auth/{**} | id DocumentOptions | Authority | OK | getAuthority | Get Authority Details | ||
POST | /api/_auth/{**:path} | DocumentOptions | Authority | CREATED | addAuthority | Add Authority | ||
PUT | /api/_auth/{**:path} | DocumentOptions | Authority | updateAuthority | Update Authority | |||
| DELETE /api/_auth/ | DocumentOptions | deleteAuthority | Delete Authority |
Mounts Endpoints
| Method | Path | Query Parameters | Request Body | Response Body | Log | Security | Description |
|---|---|---|---|---|---|---|---|
DELETE | /admin/mount/{mountId:.} /mount/{mountId:.} | DELETE | Admin | Delete Mount | |||
GET | /admin/mount /mount | MountFilter | list | Admin | Get Mount Details | ||
GET | /admin/mount/ /mount/ | show | Admin | Get Mount Details | |||
PUT | /admin/mount/ /mount/ | Mount | editPut | ||||
GET | /admin/mount//edit /mount//edit | editGet | |||||
GET | /admin/mount/create /mount/create | String | create | GET Mount | |||
POST | /admin/mount /mount | create | POST Mount |
Upload Endpoints
FileUploadController:
| Method | Path | Query Parameters | Request Body | Response Body | Log | Security | Description |
|---|---|---|---|---|---|---|---|
POST | /api/_upload/{**:path} /api/_upload | DocumentOptions MultipartHttpServletRequest | upload | ||||
POST | /_upload | MultipartFile DocumentMultipartFile | MultipartHttpServletRequest DocumentOptions | upload |
Follow Us
Stay updated with latest news!
Subscribe to our newsletter...
Comments and Discussion