List all methods of REST API and explain the API functionality
Create folder
API URL: {domain}/FileService/createFolder
METHOD: POST
Header:
Authorization : Bearer {token}
Content-Type : application/json; charset=utf-8Query Params:
offset
limitOfset
parentFolderId
Body:
{
"fileName": "folderName"
}Parameter Desc:
fileName คือ ชื่อของ folder ที่จะสร้าง
Response:
จะได้ folder id จาก file_app_id เพื่อนำมาใช้งานต่อได้
Sample Request:
Upload File
API URL: {domain}/FileService/uploadFile
METHOD: POST
Header:
Form Data:
file
parent_folder_id
filename
groupId
Parameter Desc:
file คือไฟล์ที่เป็น blob
parent_folder_id คือ id ของ folder ที่จะอัพโหลดเข้า ถ้าอัพโหลดไว้ root ไม่ต้องส่ง id
filename คือ ชื่อของไฟล์
Response:
จะได้ file id จาก file_app_id เพื่อนำมาใช้งานต่อได้
Sample Request:
Rename
API URL: {domain}/FileService/rename
METHOD: POST
Header:
Body:
Parameter Desc:
renameTo คือ ชื่อใหม่ของ folder/file ที่จะเปลี่ยนชื่อ
oldName คือ ชื่อเก่าของ folder/file ที่จะเปลี่ยนชื่อ
fileId คือ id ของ folder/file ที่จะเปลี่ยนชื่อ
Response:
จะได้ข้อมูล folder/file ที่แก้ไขชื่อแล้ว
Sample Request:
Get File from Folder
API URL: {domain}/FileService/getFiles?offset=0&limitOfset=30&parentFolderId=
METHOD: GET
Header:
Query Params:
Parameter Desc:
offset คือ ต่ำแหน่งเริ่มต้นที่จะดึงไฟล์
limitOfset คือ จำนวนการดึงไฟล์
parentFolderId คือ id ของ folder ที่จะอดึงไฟล์ ถ้าดึงจาก root ไม่ต้องส่ง id
Response:
Sample Request:
List File from Community or Group
API URL: {domain}/FileService/getFiles?groupId=xxx&offset=0&limitOfset=30&parentFolderId=
METHOD: GET
Header:
Query Params:
Parameter Desc:
groupId the community/ group id
offset คือ ต่ำแหน่งเริ่มต้นที่จะดึงไฟล์
limitOfset คือ จำนวนการดึงไฟล์
parentFolderId คือ id ของ folder ที่จะอดึงไฟล์ ถ้าดึงจาก root ไม่ต้องส่ง id
Response:
Sample Request:
Download File
API URL: {domain}/FileService/download?fileId=xxx
METHOD: GET
Header:
Query Params:
Parameter Desc:
fileId คือ id ของ file ที่จะดาวน์โหลด
Response:
จะได้ stream file
Sample Request:
Move File to Trash
API URL: {domain}/FileService/moveFileToTrash
METHOD: POST
Header:
Body:
Parameter Desc:
fileId คือ id ของ folder/file ที่จะลบไปยังถังขยะ
Response:
Sample Request:
List Files from Trash
API URL: {domain}/FileService/getFilesInTash?offset=0&limitOfset=30
METHOD: GET
Header:
Query Params:
Parameter Desc:
offset คือ ต่ำแหน่งเริ่มต้นที่จะดึงไฟล์
limitOfset คือ จำนวนการดึงไฟล์
Response:
จะได้ file_app_id และ file_path เพื่อนำมาใช้งานต่อได้
Delete Files from Trash
API URL: {domain}/FileService/deleteFromTrash
METHOD: POST
Header:
Body:
Parameter Desc:
fileId คือ id ของ folder/file ที่จะลบออกจากยังถังขยะ
Response:
Restore Files from Trash
API URL: {domain}/FileService/restore
METHOD: POST
Header:
Body:
Parameter Desc:
fileId คือ id ของ folder/file ที่จะ restore ออกจากยังถังขยะ
Response:
Last updated
Was this helpful?