GET/channel-folders/{channelFolderId}/link-setting

Gets link settings required to create a link for channel folder.

Authorization

oauth2

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

Scope

file
file.read
group.folder
group.folder.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/channel-folders/{channelFolderId}/link-setting

Path Parameters

ParameterTypeDescription
channelFolderId string 

orgunit/group/messageroom Folder ID


required
example : @900000014040402 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
enabledOrganizationAccessType boolean 

Indicates whether a link with the accessType ORGANIZATION can be created.

 
enabledSpecificPeopleAccessType boolean 

Indicates whether a link with the accessType SPECIFIC_PEOPLE can be created.

 
enabledAnyoneAccessType boolean 

Indicates whether a link with the accessType ANYONE can be created.

 
maxLinkRetentionDays integer 

Maximum retention period in days. When creating or updating a link, the expirationTime value must be less than the maxLinkRetentionDays value.

  • -1: No expiration date
  • 7: 7 days
  • 30: 30 days
  • 90: 90 days
  • 180: 180 days

Allowed values : -1, 7, 30, 90, 180 

Response Example

example

1{2  "enabledOrganizationAccessType": true,3  "enabledSpecificPeopleAccessType": true,4  "enabledAnyoneAccessType": false,5  "maxLinkRetentionDays": 306}