User must be logged in to Asite Platform using Login API FunctionThe Document List API returns a list of documents in a project folder. Extract session id from the xml of login API Call <Sessionid> tag from the resultant xml of Login API and URI tag for Document List from Workspace List API to execute Folder List API Service.
Extract the session id from the xml of the login API Call <Sessionid> tag from the resultant xml
Usage Rules
User must be logged in to Asite Platform using Login API Function
User must have executed Workspace Folder List API to get the URI
for Documents List
Use the following cURL command to list the Documents
curl --cacert "<certificate filepath>\AsiteAPI.cer" --cookie ASessionID="<session ID from the resultant XML of Login API call> <URI tag value for First page doc list API call from the resultant XML of folders API call >[?sharelinkoptional_param1=value1& sharelinkoptional_param2=value2]
Pick up the URI Tag value for the specific folder name for which
the document listing is required.
Pick up the URI Tag value for the specific folder name for which
the incomplete actions document listing is required
Input Parameters
Parameter Name |
Description |
--cacert |
Asite certificate file path |
ASessionID |
session ID from the resultant XML of Login API call> |
<URI> |
URI tag value for First page doc list API call from the resultant XML of folders API call |
generateShareLink |
Optional parameter to specify whether to generate document link or not value can be : true : public link false : direct/private link(require login) |
showLatestRevision |
Optional parameter to specify whether to access latest revision or not for link value can be : true : access latest revision of document false : access revision on which link was created ACCESS can be view/download based on openAndView option |
notifiyOnDownload |
Optional parameter to specify whether to send mail to link creator, when document download using shared link(only receive mail for public link) |
openAndView |
Optional parameter to specify whether to open document for view or download document when access document using link |
expiryAfterDuration |
Shared link param which specify unit after that link will expire after specified unit Unit can be h : hours or d : days [1-24] h : after specific hours link will expiry [1-n]d : after specific day link will expiry Example : 9d , 10h |
expiryAfterViewCnt |
Shared link param which specify ACCESS count after that link will expiry Value can be any number greater than 0 |
Note: expiryAfterDuration and expiryAfterViewCnt only applied if generateShareLink:true and folder level setting Enable Public Links sets to true
In case of generateShareLink:true and (expiryAfterDuration or expiryAfterViewCnt) is not specify then it will generate link which never expiry respect to folder level Enable Public Links option.
Click here for detailed
help on Asite API Services.
Useful Links: