Search Documentation
Share API
The share API provides REST API to perform functions on shares such as adding, updating, deleting, etc.
New Share
POST /api/v1/share/add
Creates a new Share.
Request Body
{
"title": "string",
"location": "string",
"notifyEmails": "string",
"path": "string",
"description": "string",
"startupMessage": "string",
"authenticationId": 0,
"canDelete": true,
"canUpload": true,
"canCreateFolder": true,
"canDownload": true,
"canDownloadFolder": true,
"canView": true,
"canRename": true,
"alertDelete": true,
"alertUpload": true,
"alertCreateFolder": true,
"alertDownload": true,
"alertView": true,
"alertRename": true,
"copyProtect": true,
"waterMarkText": "string",
"digitalSignReason": "string",
"groupNames": "string",
"userNames": "string",
"allowAllUsers": true,
"validityStartDate": "2024-09-09T14:03:39.909Z",
"validityEndDate": "2024-09-09T14:03:39.909Z",
"digitalSignature": true,
"active": true,
"proxyMode": true,
"folder": true
}| Property | Mandatory | Description |
|---|---|---|
|
title |
yes |
name for the share |
|
Location |
yes |
region of the storage |
|
Notify Emails |
no |
one or more email address separated by comma. |
|
path |
Yes |
file path of the storage to be shared. |
|
Description |
no |
Description of the share |
|
startupMessage |
no |
startup message. |
|
AuthenticationId |
yes |
Login profile id. |
|
CanDelete |
yes |
(true/false) permission |
|
canUpload |
yes |
(true/false) permission |
|
canCreateFolder |
yes |
(true/false) permission |
|
canDownload |
yes |
(true/false) permission |
|
canDownloadFolder |
Yes |
(true/false) permission |
|
canView |
Yes |
(true/false) permission |
|
canRename |
Yes |
(true/false) permission |
|
alertDelete |
Yes |
(true/false) permission |
|
alertUpload |
no |
(true/false) email alert for the event. |
|
alertCreateFolder |
no |
(true/false) email alert for the event. |
|
alertDownload |
no |
(true/false) email alert for the event. |
|
alertView |
no |
(true/false) email alert for the event. |
|
alertRename |
no |
(true/false) email alert for the event. |
|
copyProtect |
no |
(true/false) email alert for the event. |
|
waterMarkText |
no |
Watermark text for copy protect download for documents. |
|
digitalSignReason |
no |
Reason text for digital signature. |
|
groupNames |
no |
group name or id of identity provider to provide access restriction to the users of this group. Mention one ore more group name or id. |
|
userNames |
Yes |
One or more access usernames for whom the share access will be restricted with. |
|
allowAllUsers |
Yes |
(true/false) true if no restriction to users, otherwise restrict to allowed user names or group. |
|
validityStartDate |
No |
Share validity start date. |
|
validityEndDate |
No |
Share validity end date. |
|
digitalSignature |
No |
digital signature |
|
Proxy Mode |
yes |
(true/false) upload and download of files to use reverse proxy mode. |
|
folder |
yes |
(true/false) is share path a folder or not |
|
active |
yes |
(true/false) share active or inactive |
Response Success
Code – 200
{
"timestamp": "2024-08-12T07:08:19.237Z",
"status": 0,
"messageId": 0,
"message": "string"
}Error Response
In order to know the response that occurs in case of an error during the execution of this API, you can refer to this link.
Update
POST /api/v1/share/update
This API updates the share data.
Request Body
{
"id": 0,
"title": "string",
"notifyEmails": "string",
"description": "string",
"startupMessage": "string",
"authenticationId": 0,
"canDelete": true,
"canUpload": true,
"canCreateFolder": true,
"canDownload": true,
"canDownloadFolder": true,
"canView": true,
"canRename": true,
"alertDelete": true,
"alertUpload": true,
"alertCreateFolder": true,
"alertDownload": true,
"alertView": true,
"alertRename": true,
"copyProtect": true,
"waterMarkText": "string",
"digitalSignReason": "string",
"groupNames": "string",
"userNames": "string",
"allowAllUsers": true,
"validityStartDate": "2024-09-09T14:27:11.442Z",
"validityEndDate": "2024-09-09T14:27:11.442Z",
"digitalSignature": true,
"active": true,
"proxyMode": true,
"folder": true
}
| Property | Mandatory | Description | |
|---|---|---|---|
|
id |
yes |
share id |
|
|
title |
yes |
title of the share |
|
|
notifyEmails |
no |
one or more email address separated by comma. |
|
|
Description |
no |
Description of the share |
|
|
startupMessage |
no |
startup message |
|
|
AuthenticationId |
yes |
Login Profile id |
– |
|
CanDelete |
yes |
(true/false) permission |
|
|
canUpload |
yes |
(true/false) permission |
|
|
canCreateFolder |
yes |
(true/false) permission |
|
|
canDownload |
yes |
(true/false) permission |
|
|
canDownloadFolder |
yes |
(true/false) permission |
|
|
canView |
yes |
(true/false) permission |
|
|
canRename |
yes |
(true/false) permission |
|
|
alertDelete |
no |
(true/false) email alert for the event. |
|
|
alertUpload |
no |
(true/false) email alert for the event. |
|
|
alertCreateFolder |
no |
(true/false) email alert for the event. |
|
|
alertDownload |
no |
(true/false) email alert for the event. |
|
|
alertView |
no |
(true/false) email alert for the event. |
|
|
alertRename |
no |
(true/false) email alert for the event. |
|
|
copyProtect |
no |
(true/false) enable or disable copy protect view mode |
|
|
waterMarkText |
no |
Watermark text for copy protect download for documents. |
|
|
digitalSignReason |
no |
Reason text for digital signature. |
|
|
groupNames |
no |
group name or id of identity provider to provide access restriction to the users of this group. Mention one ore more group name or id. |
|
|
userNames |
no |
One or more access usernames for whom the share access will be restricted with. |
|
|
allowAllUsers |
yes |
(true/false) true if no restriction to users, otherwise restrict to allowed user names or group. |
|
|
validityStartDate |
no |
Share validity start date. |
|
|
validityEndDate |
no |
Share validity start date. |
|
|
folder |
yes |
(true/false) is share path a folder or not |
|
|
digitalSignature |
no |
digital signature |
|
|
proxy mode |
yes |
(true/false) upload and download of files to use reverse proxy mode. |
|
|
active |
yes |
(true/false) share active or inactive |
Response Success
Code – 200
{
"timestamp": "2024-08-13T09:38:12.284Z",
"status": 0,
"messageId": 0,
"message": "string"
}Error Response
In order to know the response that occurs in case of an error during the execution of this API, you can refer to this link.
Update shareable link
POST /api/v1/share/updateSharableLink
This API updates the shareable link with new link.
Request body
{
"id": 0,
"viewId": "string"
}| Property | Mandatory | Description |
|---|---|---|
|
id |
no |
share id |
|
viewId |
no |
Shareable view Id of the share |
Response Success
Code – 200
{
"timestamp": "2024-08-13T11:09:37.041Z",
"status": 0,
"messageId": 0,
"message": "string"
}Error Response
In order to know the response that occurs in case of an error during the execution of this API, you can refer to this link.
Fetch a share
POST /api/v1/share/get
This API fetches the existing Share.
Request body
{
"id": 0
}| Property | Mandatory | Description |
|---|---|---|
|
id |
yes |
share id |
Response Success
Code – 200
{
"id": 0,
"title": "string",
"location": "string",
"notifyEmails": "string",
"path": "string",
"viewId": "string",
"viewUrl": "string",
"authViewId": "string",
"description": "string",
"startupMessage": "string",
"tid": 0,
"authenticationId": 0,
"authTypeId": 0,
"authTypeIdStr": "string",
"allowedLogins": 0,
"canDelete": true,
"canUpload": true,
"canCreateFolder": true,
"canDownload": true,
"canDownloadFolder": true,
"canView": true,
"canRename": true,
"alertDelete": true,
"alertUpload": true,
"alertCreateFolder": true,
"alertDownload": true,
"alertView": true,
"alertRename": true,
"copyProtect": true,
"waterMarkText": "string",
"digitalSignReason": "string",
"groupNames": "string",
"userNames": "string",
"allowAllUsers": true,
"validityStartDate": "2024-09-09T14:52:35.497Z",
"validityEndDate": "2024-09-09T14:52:35.497Z",
"createdOwner": "string",
"updatedOwner": "string",
"createDateTime": "2024-09-09T14:52:35.497Z",
"updateDateTime": "2024-09-09T14:52:35.497Z",
"digitalSignature": true,
"active": true,
"proxyMode": true,
"folder": true,
"authViewUrl": "string",
"enableAuthview": true
}Error Response
In order to know the response that occurs in case of an error during the execution of this API, you can refer to this link.
Duplicate
POST /api/v1/share/duplicate
This creates a copy of the existing Share with a new title.
Request body
{
"id": 0,
"title": "string"
}| Property | Mandatory | Description |
|---|---|---|
|
id |
yes |
share id |
|
title |
yes |
title of the share |
Response Success
Code – 200
{
"timestamp": "2024-08-13T11:56:23.134Z",
"status": 0,
"messageId": 0,
"message": "string"
}Error Response
In order to know the response that occurs in case of an error during the execution of this API, you can refer to this link.
Delete
DELETE /api/v1/share/delete
This helps in deleting a Shared file or folder.
Request body
{
"id": 0
}| Property | Mandatory | Description |
|---|---|---|
|
id |
yes |
share id |
Response Success
Code – 200
{
"timestamp": "2024-08-13T14:24:00.112Z",
"status": 0,
"messageId": 0,
"message": "string"
}Error Response
In order to know the response that occurs in case of an error during the execution of this API, you can refer to this link.
Search
GET /api/v1/share/search
This API search the share data.
Request Parameter
| Parameter | Mandatory | Description | |
|---|---|---|---|
|
searchWord |
no |
keyword to search |
|
|
path |
no |
file path of the storage to be shared. |
|
|
authType |
no |
Authentication Type id |
|
|
authId |
no |
Login profile id |
|
|
startIndex |
no |
start index of the result set |
|
|
pageSize |
no |
No of records per page |
– |
|
fromDate |
no |
createDateTime |
|
|
toDate
|
no |
updateDateTime |
|
|
sortField |
no |
The field name to consider while sorting the search result |
|
|
sortOrder
|
no |
(ace/dse) ascending or descending order of the search result |
Response Success
Code – 200
{
"list": [
{
"id": 0,
"title": "string",
"location": "string",
"notifyEmails": "string",
"path": "string",
"viewId": "string",
"viewUrl": "string",
"authViewId": "string",
"description": "string",
"startupMessage": "string",
"tid": 0,
"authenticationId": 0,
"authTypeId": 0,
"authTypeIdStr": "string",
"allowedLogins": 0,
"canDelete": true,
"canUpload": true,
"canCreateFolder": true,
"canDownload": true,
"canDownloadFolder": true,
"canView": true,
"canRename": true,
"alertDelete": true,
"alertUpload": true,
"alertCreateFolder": true,
"alertDownload": true,
"alertView": true,
"alertRename": true,
"copyProtect": true,
"waterMarkText": "string",
"digitalSignReason": "string",
"groupNames": "string",
"userNames": "string",
"allowAllUsers": true,
"validityStartDate": "2024-09-12T06:04:19.887Z",
"validityEndDate": "2024-09-12T06:04:19.887Z",
"createdOwner": "string",
"updatedOwner": "string",
"createDateTime": "2024-09-12T06:04:19.888Z",
"updateDateTime": "2024-09-12T06:04:19.888Z",
"authViewUrl": "string",
"enableAuthview": true,
"folder": true,
"proxyMode": true,
"digitalSignature": true,
"active": true
}
],
"startIndex": 0,
"pageSize": 0,
"resultCount": 0,
"totalCount": 0,
"containerType": "string",
"searchType": "string",
"startupMessage": "string",
"maxFileSize": 0,
"canDelete": true,
"canUpload": true,
"canDownload": true,
"canDownloadFolder": true,
"canRename": true,
"canCreateFolder": true,
"copyProtect": true
}
Error Response
In order to know the response that occurs in case of an error during the execution of this API, you can refer to this link.