POST/groups/{groupId}/folder/files/{fileId}/protect

Marks a file in a team/group folder as Important.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

file
group.folder

HTTP Request

POSThttps://www.worksapis.com/v1.0/groups/{groupId}/folder/files/{fileId}/protect

Path Parameters

ParameterTypeDescription
groupId string 

Team/group ID


required
example : group127-8545-4463-603b-04d550d23bf 
fileId string 

File ID


required
example : NzExNTMwMDF8MTQ2NzA1NjAxMDAwMHxGfDA 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
accessedTime string 

Access date


readOnly : true 
createdTime string 

Creation date


readOnly : true 
fileId string 

File ID


readOnly : true 
parentFileId string 

File ID of the parent folder


readOnly : true 
fileName string 

File name


readOnly : true 
fileSize integer 

File size


format : int64
readOnly : true 
filePath string 

File path


readOnly : true 
fileType string 

File type

  • AUDIO: Audio file
  • DOC: Document file
  • ETC: Etc. file
  • EXE: Executable file
  • FOLDER: Folder
  • IMAGE: Image file
  • VIDEO: Video file
  • ZIP: Zip file

Allowed values : AUDIO, DOC, ETC, EXE, FOLDER, IMAGE, VIDEO, ZIP 
hasPermission boolean 

Indicates whether an access permission is set for the file.


readOnly : true 
permissionRootFileId string 

Permission root folder ID


readOnly : true
nullable : true 
shared boolean 

Indicates whether the file is shared.


readOnly : true
nullable : false 
shareRootFileId string 

Root folder ID of the shared folder


readOnly : true
nullable : true 
resourceLocation integer 

Resource location code


format : int32
readOnly : true 
statuses array (ENUM_FileStatus) 

File status

 
modifiedTime string 

Update date


readOnly : true 

ENUM_FileStatus

PropertyTypeDescription
ENUM_FileStatus string 

File status

  • LOCKED: Locked file
  • MALWARE: Malware file
  • PROTECTED: File marked as Important
  • IN_PROGRESS: File being uploaded

Allowed values : LOCKED, MALWARE, PROTECTED, IN_PROGRESS 

Response Example

example

1{2  "fileId": "QDIxMDAwMDAwMDAwMTcwfDExODE1MDg3MzQ0NzJ8RHww",3  "parentFileId": "QDIxMDAwMDAwMDAwMTcwfDExNzgyODY2MjgxMDR8RHww",4  "resourceLocation": 24101,5  "fileSize": 10,6  "fileName": "works.txt",7  "filePath": "/GroupName/worksFolder/mobile/",8  "fileType": "DOC",9  "createdTime": "2020-11-13T18:20:05.05+09:00",10  "modifiedTime": "2021-04-05T21:14:05.05+09:00",11  "accessedTime": "2021-04-05T21:14:05.05+09:00",12  "statuses": [13    "PROTECTED"14  ],15  "hasPermission": false,16  "permissionRootFileId": null,17  "shared": false,18  "shareRootFileId": null19}