comments

7 endpoints

GET/rest/comments/{id}

Get a comment

Returns the details of the specified comment, including the file it is attached to and the comment text. Requires comment_view permission on the associated file.

Parameters

Path Parameters

Required

integer

The unique identifier of the comment.

Query Parameters

with

Optional

string

With parameters

mode

Optional

string

Determines the detail level of the response body.

Responses

Returns the comment record.

Required

integer

Comment unique identifier

parentId

Required

integer

Unique identifier of the parent comment, if the comment is a reply

objectId

Required

string

Unique identifier (UUID) of the file being commented on

folderId

string

Unique identifier (UUID) of the folder containing the object being commented on

userId

Required

string

Unique identifier (UUID) of the user who authored the comment

created

string

Date and time when the comment was created

modified

string

Date and time when the comment was last modified

contents

Required

string

Text content of the comment

deleted

boolean

Indicates whether the comment has been deleted

isComment

boolean

Indicates whether the item is a comment

object

BaseObject

Class Object

Required

string

Unique identifier of object

created

string

Date and time when the object was created

deleted

boolean

Indicates whether the object is deleted

permDeleted

boolean

Indicates whether the object is permanently deleted

expire

string

Date and time when the object expires and becomes inaccessible

modified

string

Date and time when the object was last modified

name

Required

string

Display name of the object

parentId

Required

string

Parent Folder identifier

userId

Required

string

Unique identifier of Object creator

parent

Folder

Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in "with" parameter)

string

Unique identifier (UUID) of the folder.

parentId

string

Unique identifier (UUID) of the parent object.

name

string

Name of the object.

type

string

Type of the object.
f – File.
d – Folder.

userId

string

Unique identifier (UUID) who created the folder.

creator

object

Details of the user who created the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

created

string

The date and time when the object was created.

modified

string

The date and time when the object was last modified.

expire

string

Expiration timestamp of the object, if applicable.

permissions

Permission[]

List of permissions associated with the object.

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

deleted

boolean

Indicates whether the object has been deleted.

permDeleted

boolean

Indicates whether the object has been permanently deleted.

permalink

string

Permanent URL link to access the object.

path

string

Path to the folder in the hierarchy.

members

Member[]

List of members who have access to the object.

objectId

string

Unique identifier (UUID) of the associated object (file or folder).

roleId

integer

Role assigned to the member.

userId

string

Unique identifier (UUID) of the user.

groupId

integer

Unique identifier of the LDAP group.

user

object

User details of the member.

role

object

Role details assigned to the member.

group

object

Group details if the member belongs to a group.

sharedBy

object

Details of the user who shared the file or folder.

created

string

Date when the file or folder was shared.

inheritRoleId

integer

Inherited role ID from the parent folder, if applicable.

allowedFolderRoleId

integer[]

List of allowed folder role IDs.

string

Email associated with the member.

rank

integer

Rank of the member role.

originFolder

any

vendorDocId

string

Vendor document ID associated with the object.

vendorDocName

string

Name of the vendor document associated with the object.

secure

boolean

Indicates whether the folder or the parent folder containing the file is marked as secure.

source

integer

ID representing the source of the object (1 - Salesforce, 2 - Teams).

isShared

boolean

Indicates if the folder is shared with other users.

syncable

boolean

Indicates if the folder can be synced by Desktop Sync Client.

fileLifetime

integer

Time duration (in days) for which the files in this folder are kept after being added to the folder.

description

string

The description of the folder.

isFavorite

boolean

Indicates if the folder is marked as a favorite by the user.

pushedFilesCount

integer

The number of files that have been pushed to mobile apps in this folder.

currentUserRole

object

The role of the current user in this folder.

integer

Role ID

name

string

Role name

rank

integer

Role rank

type

string

Role type

avStatus

string

The Antivirus (AV) status of the folder.

dlpStatus

string

The Data Loss Prevention (DLP) status of the folder.

totalMembersCount

integer

Total number of members who have access to this folder.

totalFoldersCount

integer

Total number of subfolders within this folder.

totalFilesCount

integer

Total number of files within this folder.

maxFolderExpiration

string

The maximum expiration date allowed for files in this folder.

maxFileLifetime

integer

The maximum duration (in days) that files in this folder can be kept after being added to the folder.

isLdapGroupMember

boolean

Indicates if the folder is part of an LDAP group.

isUnderMyFolder

boolean

Indicates if this folder is a subfolder of the user's "My Folder".

pathIds

string

A list of IDs representing the path of the folder within the folder hierarchy.

isRoot

boolean

Indicates if this folder is a root folder.

rootId

string

The ID of the root folder if this is a subfolder.

useFolderQuota

boolean

Indicates if a folder quota is applied to this folder.

quota

integer

The storage quota for the folder (in bytes).

size

integer

The total storage size used by the folder (in bytes).

freeSpace

integer

The amount of free space available in the folder (in bytes).

inheritanceEnabled

boolean

Indicates if a folder inherits permissions from the parent folder

permalink

string

Permanent URL for accessing the object in the web application

creator

UserBasicInfo

Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

permissions

Permission[]

Current user's permissions (Explicit field. May be retrieved only if mentioned in "with" parameter)

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

vendorDocId

string

Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

vendorDocName

string

Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

source

integer

Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)

links

string[]

HATEOAS links associated with the entity

author

UserBasicInfo

Author of the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

parent

Comment

Class Comment

Required

integer

Comment unique identifier

parentId

Required

integer

Unique identifier of the parent comment, if the comment is a reply

objectId

Required

string

Unique identifier (UUID) of the file being commented on

folderId

string

Unique identifier (UUID) of the folder containing the object being commented on

userId

Required

string

Unique identifier (UUID) of the user who authored the comment

created

string

Date and time when the comment was created

modified

string

Date and time when the comment was last modified

contents

Required

string

Text content of the comment

deleted

boolean

Indicates whether the comment has been deleted

isComment

boolean

Indicates whether the item is a comment

object

BaseObject

Class Object

Required

string

Unique identifier of object

created

string

Date and time when the object was created

deleted

boolean

Indicates whether the object is deleted

permDeleted

boolean

Indicates whether the object is permanently deleted

expire

string

Date and time when the object expires and becomes inaccessible

modified

string

Date and time when the object was last modified

name

Required

string

Display name of the object

parentId

Required

string

Parent Folder identifier

userId

Required

string

Unique identifier of Object creator

parent

Folder

Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in "with" parameter)

string

Unique identifier (UUID) of the folder.

parentId

string

Unique identifier (UUID) of the parent object.

name

string

Name of the object.

type

string

Type of the object.
f – File.
d – Folder.

userId

string

Unique identifier (UUID) who created the folder.

creator

object

Details of the user who created the object.

created

string

The date and time when the object was created.

modified

string

The date and time when the object was last modified.

expire

string

Expiration timestamp of the object, if applicable.

permissions

Permission[]

List of permissions associated with the object.

deleted

boolean

Indicates whether the object has been deleted.

permDeleted

boolean

Indicates whether the object has been permanently deleted.

permalink

string

Permanent URL link to access the object.

path

string

Path to the folder in the hierarchy.

members

Member[]

List of members who have access to the object.

vendorDocId

string

Vendor document ID associated with the object.

vendorDocName

string

Name of the vendor document associated with the object.

secure

boolean

Indicates whether the folder or the parent folder containing the file is marked as secure.

source

integer

ID representing the source of the object (1 - Salesforce, 2 - Teams).

isShared

boolean

Indicates if the folder is shared with other users.

syncable

boolean

Indicates if the folder can be synced by Desktop Sync Client.

fileLifetime

integer

Time duration (in days) for which the files in this folder are kept after being added to the folder.

description

string

The description of the folder.

isFavorite

boolean

Indicates if the folder is marked as a favorite by the user.

pushedFilesCount

integer

The number of files that have been pushed to mobile apps in this folder.

currentUserRole

object

The role of the current user in this folder.

avStatus

string

The Antivirus (AV) status of the folder.

dlpStatus

string

The Data Loss Prevention (DLP) status of the folder.

totalMembersCount

integer

Total number of members who have access to this folder.

totalFoldersCount

integer

Total number of subfolders within this folder.

totalFilesCount

integer

Total number of files within this folder.

maxFolderExpiration

string

The maximum expiration date allowed for files in this folder.

maxFileLifetime

integer

The maximum duration (in days) that files in this folder can be kept after being added to the folder.

isLdapGroupMember

boolean

Indicates if the folder is part of an LDAP group.

isUnderMyFolder

boolean

Indicates if this folder is a subfolder of the user's "My Folder".

pathIds

string

A list of IDs representing the path of the folder within the folder hierarchy.

isRoot

boolean

Indicates if this folder is a root folder.

rootId

string

The ID of the root folder if this is a subfolder.

useFolderQuota

boolean

Indicates if a folder quota is applied to this folder.

quota

integer

The storage quota for the folder (in bytes).

size

integer

The total storage size used by the folder (in bytes).

freeSpace

integer

The amount of free space available in the folder (in bytes).

inheritanceEnabled

boolean

Indicates if a folder inherits permissions from the parent folder

permalink

string

Permanent URL for accessing the object in the web application

creator

UserBasicInfo

Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

permissions

Permission[]

Current user's permissions (Explicit field. May be retrieved only if mentioned in "with" parameter)

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

vendorDocId

string

Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

vendorDocName

string

Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

source

integer

Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)

links

string[]

HATEOAS links associated with the entity

author

UserBasicInfo

Author of the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

parent

Comment

Class Comment

Required

integer

Comment unique identifier

parentId

Required

integer

Unique identifier of the parent comment, if the comment is a reply

objectId

Required

string

Unique identifier (UUID) of the file being commented on

folderId

string

Unique identifier (UUID) of the folder containing the object being commented on

userId

Required

string

Unique identifier (UUID) of the user who authored the comment

created

string

Date and time when the comment was created

modified

string

Date and time when the comment was last modified

contents

Required

string

Text content of the comment

deleted

boolean

Indicates whether the comment has been deleted

isComment

boolean

Indicates whether the item is a comment

object

BaseObject

Class Object

Required

string

Unique identifier of object

created

string

Date and time when the object was created

deleted

boolean

Indicates whether the object is deleted

permDeleted

boolean

Indicates whether the object is permanently deleted

expire

string

Date and time when the object expires and becomes inaccessible

modified

string

Date and time when the object was last modified

name

Required

string

Display name of the object

parentId

Required

string

Parent Folder identifier

userId

Required

string

Unique identifier of Object creator

parent

Folder

Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in "with" parameter)

permalink

string

Permanent URL for accessing the object in the web application

creator

UserBasicInfo

Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in "with" parameter)

permissions

Permission[]

Current user's permissions (Explicit field. May be retrieved only if mentioned in "with" parameter)

vendorDocId

string

Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

vendorDocName

string

Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

source

integer

Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)

links

string[]

HATEOAS links associated with the entity

author

UserBasicInfo

Author of the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

parent

Comment

Class Comment

Required

integer

Comment unique identifier

parentId

Required

integer

Unique identifier of the parent comment, if the comment is a reply

objectId

Required

string

Unique identifier (UUID) of the file being commented on

folderId

string

Unique identifier (UUID) of the folder containing the object being commented on

userId

Required

string

Unique identifier (UUID) of the user who authored the comment

created

string

Date and time when the comment was created

modified

string

Date and time when the comment was last modified

contents

Required

string

Text content of the comment

deleted

boolean

Indicates whether the comment has been deleted

isComment

boolean

Indicates whether the item is a comment

object

BaseObject

Class Object

author

UserBasicInfo

Author of the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

parent

Comment

Class Comment

permissions

Permission[]

Permissions of the current user regarding the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

links

string[]

HATEOAS links associated with the entity

permissions

Permission[]

Permissions of the current user regarding the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

links

string[]

HATEOAS links associated with the entity

permissions

Permission[]

Permissions of the current user regarding the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

links

string[]

HATEOAS links associated with the entity

permissions

Permission[]

Permissions of the current user regarding the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

links

string[]

HATEOAS links associated with the entity

Request blocked by WAF

Empty response body.

Shell

curl -X GET \
  "https://{instance}.kiteworks.com/rest/comments/:id" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

id = "VALUE"  # The unique identifier of the comment.

url = f"https://{{instance}}.kiteworks.com/rest/comments/{id}"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())

Responses

{ "id": 201, "parent_id": 0, "object_id": 7, "folder_id": 3, "user_id": 5, "created": "2024-03-15T10:00:00+00:00", "modified": "2024-03-15T10:00:00+00:00", "contents": "Please review section 3.", "deleted": false, "is_comment": true }

// Error - No Body

PUT/rest/comments/{id}

Update a comment

Updates the text of the specified comment. Requires comment_edit permission on the associated file. Only the comment author or a folder manager may update the comment.

Parameters

Path Parameters

Required

integer

The unique identifier of the comment.

Request Body

contents

Required

string

Text content of the comment

addLinks

boolean

Indicates whether HATEOAS links should be included in the response

Responses

Returns the updated comment record.

Required

integer

Comment unique identifier

parentId

Required

integer

Unique identifier of the parent comment, if the comment is a reply

objectId

Required

string

Unique identifier (UUID) of the file being commented on

folderId

string

Unique identifier (UUID) of the folder containing the object being commented on

userId

Required

string

Unique identifier (UUID) of the user who authored the comment

created

string

Date and time when the comment was created

modified

string

Date and time when the comment was last modified

contents

Required

string

Text content of the comment

deleted

boolean

Indicates whether the comment has been deleted

isComment

boolean

Indicates whether the item is a comment

object

BaseObject

Class Object

Required

string

Unique identifier of object

created

string

Date and time when the object was created

deleted

boolean

Indicates whether the object is deleted

permDeleted

boolean

Indicates whether the object is permanently deleted

expire

string

Date and time when the object expires and becomes inaccessible

modified

string

Date and time when the object was last modified

name

Required

string

Display name of the object

parentId

Required

string

Parent Folder identifier

userId

Required

string

Unique identifier of Object creator

parent

Folder

Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in "with" parameter)

string

Unique identifier (UUID) of the folder.

parentId

string

Unique identifier (UUID) of the parent object.

name

string

Name of the object.

type

string

Type of the object.
f – File.
d – Folder.

userId

string

Unique identifier (UUID) who created the folder.

creator

object

Details of the user who created the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

created

string

The date and time when the object was created.

modified

string

The date and time when the object was last modified.

expire

string

Expiration timestamp of the object, if applicable.

permissions

Permission[]

List of permissions associated with the object.

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

deleted

boolean

Indicates whether the object has been deleted.

permDeleted

boolean

Indicates whether the object has been permanently deleted.

permalink

string

Permanent URL link to access the object.

path

string

Path to the folder in the hierarchy.

members

Member[]

List of members who have access to the object.

objectId

string

Unique identifier (UUID) of the associated object (file or folder).

roleId

integer

Role assigned to the member.

userId

string

Unique identifier (UUID) of the user.

groupId

integer

Unique identifier of the LDAP group.

user

object

User details of the member.

role

object

Role details assigned to the member.

group

object

Group details if the member belongs to a group.

sharedBy

object

Details of the user who shared the file or folder.

created

string

Date when the file or folder was shared.

inheritRoleId

integer

Inherited role ID from the parent folder, if applicable.

allowedFolderRoleId

integer[]

List of allowed folder role IDs.

string

Email associated with the member.

rank

integer

Rank of the member role.

originFolder

any

vendorDocId

string

Vendor document ID associated with the object.

vendorDocName

string

Name of the vendor document associated with the object.

secure

boolean

Indicates whether the folder or the parent folder containing the file is marked as secure.

source

integer

ID representing the source of the object (1 - Salesforce, 2 - Teams).

isShared

boolean

Indicates if the folder is shared with other users.

syncable

boolean

Indicates if the folder can be synced by Desktop Sync Client.

fileLifetime

integer

Time duration (in days) for which the files in this folder are kept after being added to the folder.

description

string

The description of the folder.

isFavorite

boolean

Indicates if the folder is marked as a favorite by the user.

pushedFilesCount

integer

The number of files that have been pushed to mobile apps in this folder.

currentUserRole

object

The role of the current user in this folder.

integer

Role ID

name

string

Role name

rank

integer

Role rank

type

string

Role type

avStatus

string

The Antivirus (AV) status of the folder.

dlpStatus

string

The Data Loss Prevention (DLP) status of the folder.

totalMembersCount

integer

Total number of members who have access to this folder.

totalFoldersCount

integer

Total number of subfolders within this folder.

totalFilesCount

integer

Total number of files within this folder.

maxFolderExpiration

string

The maximum expiration date allowed for files in this folder.

maxFileLifetime

integer

The maximum duration (in days) that files in this folder can be kept after being added to the folder.

isLdapGroupMember

boolean

Indicates if the folder is part of an LDAP group.

isUnderMyFolder

boolean

Indicates if this folder is a subfolder of the user's "My Folder".

pathIds

string

A list of IDs representing the path of the folder within the folder hierarchy.

isRoot

boolean

Indicates if this folder is a root folder.

rootId

string

The ID of the root folder if this is a subfolder.

useFolderQuota

boolean

Indicates if a folder quota is applied to this folder.

quota

integer

The storage quota for the folder (in bytes).

size

integer

The total storage size used by the folder (in bytes).

freeSpace

integer

The amount of free space available in the folder (in bytes).

inheritanceEnabled

boolean

Indicates if a folder inherits permissions from the parent folder

permalink

string

Permanent URL for accessing the object in the web application

creator

UserBasicInfo

Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

permissions

Permission[]

Current user's permissions (Explicit field. May be retrieved only if mentioned in "with" parameter)

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

vendorDocId

string

Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

vendorDocName

string

Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

source

integer

Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)

links

string[]

HATEOAS links associated with the entity

author

UserBasicInfo

Author of the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

parent

Comment

Class Comment

Required

integer

Comment unique identifier

parentId

Required

integer

Unique identifier of the parent comment, if the comment is a reply

objectId

Required

string

Unique identifier (UUID) of the file being commented on

folderId

string

Unique identifier (UUID) of the folder containing the object being commented on

userId

Required

string

Unique identifier (UUID) of the user who authored the comment

created

string

Date and time when the comment was created

modified

string

Date and time when the comment was last modified

contents

Required

string

Text content of the comment

deleted

boolean

Indicates whether the comment has been deleted

isComment

boolean

Indicates whether the item is a comment

object

BaseObject

Class Object

Required

string

Unique identifier of object

created

string

Date and time when the object was created

deleted

boolean

Indicates whether the object is deleted

permDeleted

boolean

Indicates whether the object is permanently deleted

expire

string

Date and time when the object expires and becomes inaccessible

modified

string

Date and time when the object was last modified

name

Required

string

Display name of the object

parentId

Required

string

Parent Folder identifier

userId

Required

string

Unique identifier of Object creator

parent

Folder

Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in "with" parameter)

string

Unique identifier (UUID) of the folder.

parentId

string

Unique identifier (UUID) of the parent object.

name

string

Name of the object.

type

string

Type of the object.
f – File.
d – Folder.

userId

string

Unique identifier (UUID) who created the folder.

creator

object

Details of the user who created the object.

created

string

The date and time when the object was created.

modified

string

The date and time when the object was last modified.

expire

string

Expiration timestamp of the object, if applicable.

permissions

Permission[]

List of permissions associated with the object.

deleted

boolean

Indicates whether the object has been deleted.

permDeleted

boolean

Indicates whether the object has been permanently deleted.

permalink

string

Permanent URL link to access the object.

path

string

Path to the folder in the hierarchy.

members

Member[]

List of members who have access to the object.

vendorDocId

string

Vendor document ID associated with the object.

vendorDocName

string

Name of the vendor document associated with the object.

secure

boolean

Indicates whether the folder or the parent folder containing the file is marked as secure.

source

integer

ID representing the source of the object (1 - Salesforce, 2 - Teams).

isShared

boolean

Indicates if the folder is shared with other users.

syncable

boolean

Indicates if the folder can be synced by Desktop Sync Client.

fileLifetime

integer

Time duration (in days) for which the files in this folder are kept after being added to the folder.

description

string

The description of the folder.

isFavorite

boolean

Indicates if the folder is marked as a favorite by the user.

pushedFilesCount

integer

The number of files that have been pushed to mobile apps in this folder.

currentUserRole

object

The role of the current user in this folder.

avStatus

string

The Antivirus (AV) status of the folder.

dlpStatus

string

The Data Loss Prevention (DLP) status of the folder.

totalMembersCount

integer

Total number of members who have access to this folder.

totalFoldersCount

integer

Total number of subfolders within this folder.

totalFilesCount

integer

Total number of files within this folder.

maxFolderExpiration

string

The maximum expiration date allowed for files in this folder.

maxFileLifetime

integer

The maximum duration (in days) that files in this folder can be kept after being added to the folder.

isLdapGroupMember

boolean

Indicates if the folder is part of an LDAP group.

isUnderMyFolder

boolean

Indicates if this folder is a subfolder of the user's "My Folder".

pathIds

string

A list of IDs representing the path of the folder within the folder hierarchy.

isRoot

boolean

Indicates if this folder is a root folder.

rootId

string

The ID of the root folder if this is a subfolder.

useFolderQuota

boolean

Indicates if a folder quota is applied to this folder.

quota

integer

The storage quota for the folder (in bytes).

size

integer

The total storage size used by the folder (in bytes).

freeSpace

integer

The amount of free space available in the folder (in bytes).

inheritanceEnabled

boolean

Indicates if a folder inherits permissions from the parent folder

permalink

string

Permanent URL for accessing the object in the web application

creator

UserBasicInfo

Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

permissions

Permission[]

Current user's permissions (Explicit field. May be retrieved only if mentioned in "with" parameter)

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

vendorDocId

string

Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

vendorDocName

string

Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

source

integer

Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)

links

string[]

HATEOAS links associated with the entity

author

UserBasicInfo

Author of the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

parent

Comment

Class Comment

Required

integer

Comment unique identifier

parentId

Required

integer

Unique identifier of the parent comment, if the comment is a reply

objectId

Required

string

Unique identifier (UUID) of the file being commented on

folderId

string

Unique identifier (UUID) of the folder containing the object being commented on

userId

Required

string

Unique identifier (UUID) of the user who authored the comment

created

string

Date and time when the comment was created

modified

string

Date and time when the comment was last modified

contents

Required

string

Text content of the comment

deleted

boolean

Indicates whether the comment has been deleted

isComment

boolean

Indicates whether the item is a comment

object

BaseObject

Class Object

Required

string

Unique identifier of object

created

string

Date and time when the object was created

deleted

boolean

Indicates whether the object is deleted

permDeleted

boolean

Indicates whether the object is permanently deleted

expire

string

Date and time when the object expires and becomes inaccessible

modified

string

Date and time when the object was last modified

name

Required

string

Display name of the object

parentId

Required

string

Parent Folder identifier

userId

Required

string

Unique identifier of Object creator

parent

Folder

Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in "with" parameter)

permalink

string

Permanent URL for accessing the object in the web application

creator

UserBasicInfo

Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in "with" parameter)

permissions

Permission[]

Current user's permissions (Explicit field. May be retrieved only if mentioned in "with" parameter)

vendorDocId

string

Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

vendorDocName

string

Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

source

integer

Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)

links

string[]

HATEOAS links associated with the entity

author

UserBasicInfo

Author of the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

parent

Comment

Class Comment

Required

integer

Comment unique identifier

parentId

Required

integer

Unique identifier of the parent comment, if the comment is a reply

objectId

Required

string

Unique identifier (UUID) of the file being commented on

folderId

string

Unique identifier (UUID) of the folder containing the object being commented on

userId

Required

string

Unique identifier (UUID) of the user who authored the comment

created

string

Date and time when the comment was created

modified

string

Date and time when the comment was last modified

contents

Required

string

Text content of the comment

deleted

boolean

Indicates whether the comment has been deleted

isComment

boolean

Indicates whether the item is a comment

object

BaseObject

Class Object

author

UserBasicInfo

Author of the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

parent

Comment

Class Comment

permissions

Permission[]

Permissions of the current user regarding the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

links

string[]

HATEOAS links associated with the entity

permissions

Permission[]

Permissions of the current user regarding the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

links

string[]

HATEOAS links associated with the entity

permissions

Permission[]

Permissions of the current user regarding the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

links

string[]

HATEOAS links associated with the entity

permissions

Permission[]

Permissions of the current user regarding the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

links

string[]

HATEOAS links associated with the entity

Unprocessable Content

Possible error codes: ERR_INPUT_MAX_VALUE, ERR_INPUT_HTML_TAGS_INVALID, ERR_INPUT_REQUIRED

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X PUT \
  "https://{instance}.kiteworks.com/rest/comments/:id" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "contents": "string",
         "addLinks": true
       }'

Python

import requests

id = "VALUE"  # The unique identifier of the comment.

url = f"https://{{instance}}.kiteworks.com/rest/comments/{id}"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json",
}
payload = {
  "contents": "string",
  "addLinks": true
}
response = requests.put(url, headers=headers, json=payload)
print(response.json())

Responses

{ "id": 201, "parent_id": 0, "object_id": 7, "folder_id": 3, "user_id": 5, "created": "2024-03-15T10:00:00+00:00", "modified": "2024-03-16T08:00:00+00:00", "contents": "Please review section 3 and section 4.", "deleted": false, "is_comment": true }

{ "errors": { "code": "ERR_INPUT_HTML_TAGS_INVALID", "message": "Cannot contain HTML tags other than B, I, or U" } }

{ "errors": { "code": "ERR_INPUT_REQUIRED", "message": "Field is required" } }

// Error - No Body

DELETE/rest/comments/{id}

Delete a comment

Deletes the specified comment. Requires comment_delete permission on the associated file. Only the comment author or a folder manager may delete the comment.

Parameters

Path Parameters

Required

integer

The unique identifier of the comment.

Responses

The comment was successfully deleted. Returns no content.

Empty response body.

Request blocked by WAF

Empty response body.

Shell

curl -X DELETE \
  "https://{instance}.kiteworks.com/rest/comments/:id" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

id = "VALUE"  # The unique identifier of the comment.

url = f"https://{{instance}}.kiteworks.com/rest/comments/{id}"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.delete(url, headers=headers)
print(response.json())

Responses

// Request successful - No Body

// Error - No Body

GET/rest/files/{id}/comments

Get file comments

Returns a list of comments on the specified file. Requires comment_view permission on the file.

Parameters

Path Parameters

Required

string

The unique identifier (UUID) of the file.

Query Parameters

parentId

Optional

integer

Unique identifier of the parent comment

parentId:in

Optional

integer

Unique identifier of the parent comment. Search for results that match any of the specified values for this parameter.

userId

Optional

string

Unique identifier of the comment author

userId:in

Optional

string

Unique identifier of the comment author. Search for results that match any of the specified values for this parameter.

created

Optional

string

The creation date of the comment.

created:gt

Optional

string

The creation date of the comment.. Search for results where this parameter value is greater than the specified value.

created:gte

Optional

string

The creation date of the comment.. Search for results where this parameter value is greater than or equal to the specified value.

created:lt

Optional

string

The creation date of the comment.. Search for results where this parameter value is less than the specified value.

created:lte

Optional

string

The creation date of the comment.. Search for results where this parameter value is less than or equal to the specified value.

modified

Optional

string

The last modification date of the comment.

modified:gt

Optional

string

The last modification date of the comment.. Search for results where this parameter value is greater than the specified value.

modified:gte

Optional

string

The last modification date of the comment.. Search for results where this parameter value is greater than or equal to the specified value.

modified:lt

Optional

string

The last modification date of the comment.. Search for results where this parameter value is less than the specified value.

modified:lte

Optional

string

The last modification date of the comment.. Search for results where this parameter value is less than or equal to the specified value.

contents:contains

Optional

string

Content of the comment. Search for results that contain the specified characters in this parameter.

orderBy

Optional

string[]

Sorting options

offset

Optional

integer

Offset

limit

Optional

integer

Limit

with

Optional

string

With parameters

mode

Optional

string

Determines the detail level of the response body.

Responses

Returns a paginated list of comments for the specified file.

data

Comment[]

Required

integer

Comment unique identifier

parentId

Required

integer

Unique identifier of the parent comment, if the comment is a reply

objectId

Required

string

Unique identifier (UUID) of the file being commented on

folderId

string

Unique identifier (UUID) of the folder containing the object being commented on

userId

Required

string

Unique identifier (UUID) of the user who authored the comment

created

string

Date and time when the comment was created

modified

string

Date and time when the comment was last modified

contents

Required

string

Text content of the comment

deleted

boolean

Indicates whether the comment has been deleted

isComment

boolean

Indicates whether the item is a comment

object

BaseObject

Class Object

Required

string

Unique identifier of object

created

string

Date and time when the object was created

deleted

boolean

Indicates whether the object is deleted

permDeleted

boolean

Indicates whether the object is permanently deleted

expire

string

Date and time when the object expires and becomes inaccessible

modified

string

Date and time when the object was last modified

name

Required

string

Display name of the object

parentId

Required

string

Parent Folder identifier

userId

Required

string

Unique identifier of Object creator

parent

Folder

Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in "with" parameter)

string

Unique identifier (UUID) of the folder.

parentId

string

Unique identifier (UUID) of the parent object.

name

string

Name of the object.

type

string

Type of the object.
f – File.
d – Folder.

userId

string

Unique identifier (UUID) who created the folder.

creator

object

Details of the user who created the object.

created

string

The date and time when the object was created.

modified

string

The date and time when the object was last modified.

expire

string

Expiration timestamp of the object, if applicable.

permissions

Permission[]

List of permissions associated with the object.

deleted

boolean

Indicates whether the object has been deleted.

permDeleted

boolean

Indicates whether the object has been permanently deleted.

permalink

string

Permanent URL link to access the object.

path

string

Path to the folder in the hierarchy.

members

Member[]

List of members who have access to the object.

vendorDocId

string

Vendor document ID associated with the object.

vendorDocName

string

Name of the vendor document associated with the object.

secure

boolean

Indicates whether the folder or the parent folder containing the file is marked as secure.

source

integer

ID representing the source of the object (1 - Salesforce, 2 - Teams).

isShared

boolean

Indicates if the folder is shared with other users.

syncable

boolean

Indicates if the folder can be synced by Desktop Sync Client.

fileLifetime

integer

Time duration (in days) for which the files in this folder are kept after being added to the folder.

description

string

The description of the folder.

isFavorite

boolean

Indicates if the folder is marked as a favorite by the user.

pushedFilesCount

integer

The number of files that have been pushed to mobile apps in this folder.

currentUserRole

object

The role of the current user in this folder.

avStatus

string

The Antivirus (AV) status of the folder.

dlpStatus

string

The Data Loss Prevention (DLP) status of the folder.

totalMembersCount

integer

Total number of members who have access to this folder.

totalFoldersCount

integer

Total number of subfolders within this folder.

totalFilesCount

integer

Total number of files within this folder.

maxFolderExpiration

string

The maximum expiration date allowed for files in this folder.

maxFileLifetime

integer

The maximum duration (in days) that files in this folder can be kept after being added to the folder.

isLdapGroupMember

boolean

Indicates if the folder is part of an LDAP group.

isUnderMyFolder

boolean

Indicates if this folder is a subfolder of the user's "My Folder".

pathIds

string

A list of IDs representing the path of the folder within the folder hierarchy.

isRoot

boolean

Indicates if this folder is a root folder.

rootId

string

The ID of the root folder if this is a subfolder.

useFolderQuota

boolean

Indicates if a folder quota is applied to this folder.

quota

integer

The storage quota for the folder (in bytes).

size

integer

The total storage size used by the folder (in bytes).

freeSpace

integer

The amount of free space available in the folder (in bytes).

inheritanceEnabled

boolean

Indicates if a folder inherits permissions from the parent folder

permalink

string

Permanent URL for accessing the object in the web application

creator

UserBasicInfo

Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

permissions

Permission[]

Current user's permissions (Explicit field. May be retrieved only if mentioned in "with" parameter)

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

vendorDocId

string

Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

vendorDocName

string

Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

source

integer

Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)

links

string[]

HATEOAS links associated with the entity

author

UserBasicInfo

Author of the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

parent

Comment

Class Comment

Required

integer

Comment unique identifier

parentId

Required

integer

Unique identifier of the parent comment, if the comment is a reply

objectId

Required

string

Unique identifier (UUID) of the file being commented on

folderId

string

Unique identifier (UUID) of the folder containing the object being commented on

userId

Required

string

Unique identifier (UUID) of the user who authored the comment

created

string

Date and time when the comment was created

modified

string

Date and time when the comment was last modified

contents

Required

string

Text content of the comment

deleted

boolean

Indicates whether the comment has been deleted

isComment

boolean

Indicates whether the item is a comment

object

BaseObject

Class Object

Required

string

Unique identifier of object

created

string

Date and time when the object was created

deleted

boolean

Indicates whether the object is deleted

permDeleted

boolean

Indicates whether the object is permanently deleted

expire

string

Date and time when the object expires and becomes inaccessible

modified

string

Date and time when the object was last modified

name

Required

string

Display name of the object

parentId

Required

string

Parent Folder identifier

userId

Required

string

Unique identifier of Object creator

parent

Folder

Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in "with" parameter)

permalink

string

Permanent URL for accessing the object in the web application

creator

UserBasicInfo

Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in "with" parameter)

permissions

Permission[]

Current user's permissions (Explicit field. May be retrieved only if mentioned in "with" parameter)

vendorDocId

string

Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

vendorDocName

string

Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

source

integer

Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)

links

string[]

HATEOAS links associated with the entity

author

UserBasicInfo

Author of the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

parent

Comment

Class Comment

Required

integer

Comment unique identifier

parentId

Required

integer

Unique identifier of the parent comment, if the comment is a reply

objectId

Required

string

Unique identifier (UUID) of the file being commented on

folderId

string

Unique identifier (UUID) of the folder containing the object being commented on

userId

Required

string

Unique identifier (UUID) of the user who authored the comment

created

string

Date and time when the comment was created

modified

string

Date and time when the comment was last modified

contents

Required

string

Text content of the comment

deleted

boolean

Indicates whether the comment has been deleted

isComment

boolean

Indicates whether the item is a comment

object

BaseObject

Class Object

author

UserBasicInfo

Author of the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

parent

Comment

Class Comment

permissions

Permission[]

Permissions of the current user regarding the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

links

string[]

HATEOAS links associated with the entity

permissions

Permission[]

Permissions of the current user regarding the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

links

string[]

HATEOAS links associated with the entity

permissions

Permission[]

Permissions of the current user regarding the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

links

string[]

HATEOAS links associated with the entity

metadata

MetaData

total

integer

Total number of items available.

limit

integer

Maximum number of items returned per page.

offset

integer

Number of items skipped before the current page.

Request blocked by WAF

Empty response body.

Shell

curl -X GET \
  "https://{instance}.kiteworks.com/rest/files/:id/comments" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

id = "VALUE"  # The unique identifier (UUID) of the file.

url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/comments"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())

Responses

{ "data": [ { "id": 201, "parent_id": 0, "object_id": 7, "folder_id": 3, "user_id": 5, "created": "2024-03-15T10:00:00+00:00", "modified": "2024-03-15T10:00:00+00:00", "contents": "Please review section 3.", "deleted": false, "is_comment": true }, { "id": 202, "parent_id": 201, "object_id": 7, "folder_id": 3, "user_id": 3, "created": "2024-03-15T11:00:00+00:00", "modified": "2024-03-15T11:00:00+00:00", "contents": "Done, updated section 3.", "deleted": false, "is_comment": true } ], "total": 2, "page": 1, "pageSize": 20 }

// Error - No Body

POST/rest/files/{id}/comments

Add file comment

Adds a comment to the specified file. To reply to an existing comment, include a parentId in the request body. Requires comment_add permission on the file.

Parameters

Path Parameters

Required

string

The unique identifier (UUID) of the file.

Query Parameters

returnEntity

Optional

boolean

If set to true, returns information about the newly created entity.

mode

Optional

string

Determines the detail level of the response body.

Request Body

parentId

integer

Unique identifier of the parent comment. Set this value when replying to an existing comment

contents

Required

string

Text content of the comment

addLinks

boolean

Indicates whether HATEOAS links should be included in the response

Responses

Returns the newly created comment record.

Required

integer

Comment unique identifier

parentId

Required

integer

Unique identifier of the parent comment, if the comment is a reply

objectId

Required

string

Unique identifier (UUID) of the file being commented on

folderId

string

Unique identifier (UUID) of the folder containing the object being commented on

userId

Required

string

Unique identifier (UUID) of the user who authored the comment

created

string

Date and time when the comment was created

modified

string

Date and time when the comment was last modified

contents

Required

string

Text content of the comment

deleted

boolean

Indicates whether the comment has been deleted

isComment

boolean

Indicates whether the item is a comment

object

BaseObject

Class Object

Required

string

Unique identifier of object

created

string

Date and time when the object was created

deleted

boolean

Indicates whether the object is deleted

permDeleted

boolean

Indicates whether the object is permanently deleted

expire

string

Date and time when the object expires and becomes inaccessible

modified

string

Date and time when the object was last modified

name

Required

string

Display name of the object

parentId

Required

string

Parent Folder identifier

userId

Required

string

Unique identifier of Object creator

parent

Folder

Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in "with" parameter)

string

Unique identifier (UUID) of the folder.

parentId

string

Unique identifier (UUID) of the parent object.

name

string

Name of the object.

type

string

Type of the object.
f – File.
d – Folder.

userId

string

Unique identifier (UUID) who created the folder.

creator

object

Details of the user who created the object.

string

Unique identifier (UUID) for the user.

string

Email address associated with the user.

name

string

Full name of the user.

profileIcon

string

URL or identifier for the user's profile icon.

created

string

The date and time when the object was created.

modified

string

The date and time when the object was last modified.

expire

string

Expiration timestamp of the object, if applicable.

permissions

Permission[]

List of permissions associated with the object.

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

deleted

boolean

Indicates whether the object has been deleted.

permDeleted

boolean

Indicates whether the object has been permanently deleted.

permalink

string

Permanent URL link to access the object.

path

string

Path to the folder in the hierarchy.

members

Member[]

List of members who have access to the object.

objectId

string

Unique identifier (UUID) of the associated object (file or folder).

roleId

integer

Role assigned to the member.

userId

string

Unique identifier (UUID) of the user.

groupId

integer

Unique identifier of the LDAP group.

user

object

User details of the member.

role

object

Role details assigned to the member.

group

object

Group details if the member belongs to a group.

sharedBy

object

Details of the user who shared the file or folder.

created

string

Date when the file or folder was shared.

inheritRoleId

integer

Inherited role ID from the parent folder, if applicable.

allowedFolderRoleId

integer[]

List of allowed folder role IDs.

string

Email associated with the member.

rank

integer

Rank of the member role.

originFolder

any

vendorDocId

string

Vendor document ID associated with the object.

vendorDocName

string

Name of the vendor document associated with the object.

secure

boolean

Indicates whether the folder or the parent folder containing the file is marked as secure.

source

integer

ID representing the source of the object (1 - Salesforce, 2 - Teams).

isShared

boolean

Indicates if the folder is shared with other users.

syncable

boolean

Indicates if the folder can be synced by Desktop Sync Client.

fileLifetime

integer

Time duration (in days) for which the files in this folder are kept after being added to the folder.

description

string

The description of the folder.

isFavorite

boolean

Indicates if the folder is marked as a favorite by the user.

pushedFilesCount

integer

The number of files that have been pushed to mobile apps in this folder.

currentUserRole

object

The role of the current user in this folder.

integer

Role ID

name

string

Role name

rank

integer

Role rank

type

string

Role type

avStatus

string

The Antivirus (AV) status of the folder.

dlpStatus

string

The Data Loss Prevention (DLP) status of the folder.

totalMembersCount

integer

Total number of members who have access to this folder.

totalFoldersCount

integer

Total number of subfolders within this folder.

totalFilesCount

integer

Total number of files within this folder.

maxFolderExpiration

string

The maximum expiration date allowed for files in this folder.

maxFileLifetime

integer

The maximum duration (in days) that files in this folder can be kept after being added to the folder.

isLdapGroupMember

boolean

Indicates if the folder is part of an LDAP group.

isUnderMyFolder

boolean

Indicates if this folder is a subfolder of the user's "My Folder".

pathIds

string

A list of IDs representing the path of the folder within the folder hierarchy.

isRoot

boolean

Indicates if this folder is a root folder.

rootId

string

The ID of the root folder if this is a subfolder.

useFolderQuota

boolean

Indicates if a folder quota is applied to this folder.

quota

integer

The storage quota for the folder (in bytes).

size

integer

The total storage size used by the folder (in bytes).

freeSpace

integer

The amount of free space available in the folder (in bytes).

inheritanceEnabled

boolean

Indicates if a folder inherits permissions from the parent folder

permalink

string

Permanent URL for accessing the object in the web application

creator

UserBasicInfo

Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

permissions

Permission[]

Current user's permissions (Explicit field. May be retrieved only if mentioned in "with" parameter)

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

vendorDocId

string

Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

vendorDocName

string

Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

source

integer

Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)

links

string[]

HATEOAS links associated with the entity

author

UserBasicInfo

Author of the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

parent

Comment

Class Comment

Required

integer

Comment unique identifier

parentId

Required

integer

Unique identifier of the parent comment, if the comment is a reply

objectId

Required

string

Unique identifier (UUID) of the file being commented on

folderId

string

Unique identifier (UUID) of the folder containing the object being commented on

userId

Required

string

Unique identifier (UUID) of the user who authored the comment

created

string

Date and time when the comment was created

modified

string

Date and time when the comment was last modified

contents

Required

string

Text content of the comment

deleted

boolean

Indicates whether the comment has been deleted

isComment

boolean

Indicates whether the item is a comment

object

BaseObject

Class Object

Required

string

Unique identifier of object

created

string

Date and time when the object was created

deleted

boolean

Indicates whether the object is deleted

permDeleted

boolean

Indicates whether the object is permanently deleted

expire

string

Date and time when the object expires and becomes inaccessible

modified

string

Date and time when the object was last modified

name

Required

string

Display name of the object

parentId

Required

string

Parent Folder identifier

userId

Required

string

Unique identifier of Object creator

parent

Folder

Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in "with" parameter)

string

Unique identifier (UUID) of the folder.

parentId

string

Unique identifier (UUID) of the parent object.

name

string

Name of the object.

type

string

Type of the object.
f – File.
d – Folder.

userId

string

Unique identifier (UUID) who created the folder.

creator

object

Details of the user who created the object.

created

string

The date and time when the object was created.

modified

string

The date and time when the object was last modified.

expire

string

Expiration timestamp of the object, if applicable.

permissions

Permission[]

List of permissions associated with the object.

deleted

boolean

Indicates whether the object has been deleted.

permDeleted

boolean

Indicates whether the object has been permanently deleted.

permalink

string

Permanent URL link to access the object.

path

string

Path to the folder in the hierarchy.

members

Member[]

List of members who have access to the object.

vendorDocId

string

Vendor document ID associated with the object.

vendorDocName

string

Name of the vendor document associated with the object.

secure

boolean

Indicates whether the folder or the parent folder containing the file is marked as secure.

source

integer

ID representing the source of the object (1 - Salesforce, 2 - Teams).

isShared

boolean

Indicates if the folder is shared with other users.

syncable

boolean

Indicates if the folder can be synced by Desktop Sync Client.

fileLifetime

integer

Time duration (in days) for which the files in this folder are kept after being added to the folder.

description

string

The description of the folder.

isFavorite

boolean

Indicates if the folder is marked as a favorite by the user.

pushedFilesCount

integer

The number of files that have been pushed to mobile apps in this folder.

currentUserRole

object

The role of the current user in this folder.

avStatus

string

The Antivirus (AV) status of the folder.

dlpStatus

string

The Data Loss Prevention (DLP) status of the folder.

totalMembersCount

integer

Total number of members who have access to this folder.

totalFoldersCount

integer

Total number of subfolders within this folder.

totalFilesCount

integer

Total number of files within this folder.

maxFolderExpiration

string

The maximum expiration date allowed for files in this folder.

maxFileLifetime

integer

The maximum duration (in days) that files in this folder can be kept after being added to the folder.

isLdapGroupMember

boolean

Indicates if the folder is part of an LDAP group.

isUnderMyFolder

boolean

Indicates if this folder is a subfolder of the user's "My Folder".

pathIds

string

A list of IDs representing the path of the folder within the folder hierarchy.

isRoot

boolean

Indicates if this folder is a root folder.

rootId

string

The ID of the root folder if this is a subfolder.

useFolderQuota

boolean

Indicates if a folder quota is applied to this folder.

quota

integer

The storage quota for the folder (in bytes).

size

integer

The total storage size used by the folder (in bytes).

freeSpace

integer

The amount of free space available in the folder (in bytes).

inheritanceEnabled

boolean

Indicates if a folder inherits permissions from the parent folder

permalink

string

Permanent URL for accessing the object in the web application

creator

UserBasicInfo

Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

permissions

Permission[]

Current user's permissions (Explicit field. May be retrieved only if mentioned in "with" parameter)

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

vendorDocId

string

Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

vendorDocName

string

Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

source

integer

Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)

links

string[]

HATEOAS links associated with the entity

author

UserBasicInfo

Author of the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

parent

Comment

Class Comment

Required

integer

Comment unique identifier

parentId

Required

integer

Unique identifier of the parent comment, if the comment is a reply

objectId

Required

string

Unique identifier (UUID) of the file being commented on

folderId

string

Unique identifier (UUID) of the folder containing the object being commented on

userId

Required

string

Unique identifier (UUID) of the user who authored the comment

created

string

Date and time when the comment was created

modified

string

Date and time when the comment was last modified

contents

Required

string

Text content of the comment

deleted

boolean

Indicates whether the comment has been deleted

isComment

boolean

Indicates whether the item is a comment

object

BaseObject

Class Object

Required

string

Unique identifier of object

created

string

Date and time when the object was created

deleted

boolean

Indicates whether the object is deleted

permDeleted

boolean

Indicates whether the object is permanently deleted

expire

string

Date and time when the object expires and becomes inaccessible

modified

string

Date and time when the object was last modified

name

Required

string

Display name of the object

parentId

Required

string

Parent Folder identifier

userId

Required

string

Unique identifier of Object creator

parent

Folder

Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in "with" parameter)

permalink

string

Permanent URL for accessing the object in the web application

creator

UserBasicInfo

Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in "with" parameter)

permissions

Permission[]

Current user's permissions (Explicit field. May be retrieved only if mentioned in "with" parameter)

vendorDocId

string

Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

vendorDocName

string

Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

source

integer

Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)

links

string[]

HATEOAS links associated with the entity

author

UserBasicInfo

Author of the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

parent

Comment

Class Comment

Required

integer

Comment unique identifier

parentId

Required

integer

Unique identifier of the parent comment, if the comment is a reply

objectId

Required

string

Unique identifier (UUID) of the file being commented on

folderId

string

Unique identifier (UUID) of the folder containing the object being commented on

userId

Required

string

Unique identifier (UUID) of the user who authored the comment

created

string

Date and time when the comment was created

modified

string

Date and time when the comment was last modified

contents

Required

string

Text content of the comment

deleted

boolean

Indicates whether the comment has been deleted

isComment

boolean

Indicates whether the item is a comment

object

BaseObject

Class Object

author

UserBasicInfo

Author of the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

parent

Comment

Class Comment

permissions

Permission[]

Permissions of the current user regarding the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

links

string[]

HATEOAS links associated with the entity

permissions

Permission[]

Permissions of the current user regarding the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

links

string[]

HATEOAS links associated with the entity

permissions

Permission[]

Permissions of the current user regarding the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

links

string[]

HATEOAS links associated with the entity

permissions

Permission[]

Permissions of the current user regarding the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

links

string[]

HATEOAS links associated with the entity

Forbidden

Possible error codes: ERR_ACCESS_USER

error

Error[]

code

string

Error code

message

string

Error message

Unprocessable Content

Possible error codes: ERR_INPUT_MAX_VALUE, ERR_INPUT_HTML_TAGS_INVALID, ERR_INPUT_REQUIRED

error

Error[]

code

string

Error code

message

string

Error message

Request blocked by WAF

Empty response body.

Shell

curl -X POST \
  "https://{instance}.kiteworks.com/rest/files/:id/comments" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "parentId": 1,
         "contents": "string",
         "addLinks": true
       }'

Python

import requests

id = "VALUE"  # The unique identifier (UUID) of the file.

url = f"https://{{instance}}.kiteworks.com/rest/files/{id}/comments"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json",
}
payload = {
  "parentId": 1,
  "contents": "string",
  "addLinks": true
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

Responses

{ "id": 203, "parent_id": 0, "object_id": 7, "folder_id": 3, "user_id": 5, "created": "2024-03-16T09:00:00+00:00", "modified": "2024-03-16T09:00:00+00:00", "contents": "Looks good to me.", "deleted": false, "is_comment": true }

{ "errors": { "code": "ERR_ACCESS_USER", "message": "Insufficient access permissions" } }

{ "errors": { "code": "ERR_INPUT_HTML_TAGS_INVALID", "message": "Cannot contain HTML tags other than B, I, or U" } }

{ "errors": { "code": "ERR_INPUT_REQUIRED", "message": "Field is required" } }

// Error - No Body

GET/rest/folders/{id}/comments

List comments for the folder

Returns all comments on files within the specified folder. Requires comment_view permission on the folder.

Parameters

Path Parameters

Required

string

The unique identifier (UUID) of the folder.

Query Parameters

parentId

Optional

integer

Unique identifier of the parent comment

parentId:in

Optional

integer

Unique identifier of the parent comment. Search for results that match any of the specified values for this parameter.

userId

Optional

string

Unique identifier of the comment author

userId:in

Optional

string

Unique identifier of the comment author. Search for results that match any of the specified values for this parameter.

created

Optional

string

The creation date of the comment.

created:gt

Optional

string

The creation date of the comment.. Search for results where this parameter value is greater than the specified value.

created:gte

Optional

string

The creation date of the comment.. Search for results where this parameter value is greater than or equal to the specified value.

created:lt

Optional

string

The creation date of the comment.. Search for results where this parameter value is less than the specified value.

created:lte

Optional

string

The creation date of the comment.. Search for results where this parameter value is less than or equal to the specified value.

modified

Optional

string

The last modification date of the comment.

modified:gt

Optional

string

The last modification date of the comment.. Search for results where this parameter value is greater than the specified value.

modified:gte

Optional

string

The last modification date of the comment.. Search for results where this parameter value is greater than or equal to the specified value.

modified:lt

Optional

string

The last modification date of the comment.. Search for results where this parameter value is less than the specified value.

modified:lte

Optional

string

The last modification date of the comment.. Search for results where this parameter value is less than or equal to the specified value.

contents:contains

Optional

string

Content of the comment. Search for results that contain the specified characters in this parameter.

orderBy

Optional

string[]

Sorting options

offset

Optional

integer

Offset

limit

Optional

integer

Limit

with

Optional

string

With parameters

mode

Optional

string

Determines the detail level of the response body.

Responses

Returns a paginated list of comments for files within the specified folder.

data

Comment[]

Required

integer

Comment unique identifier

parentId

Required

integer

Unique identifier of the parent comment, if the comment is a reply

objectId

Required

string

Unique identifier (UUID) of the file being commented on

folderId

string

Unique identifier (UUID) of the folder containing the object being commented on

userId

Required

string

Unique identifier (UUID) of the user who authored the comment

created

string

Date and time when the comment was created

modified

string

Date and time when the comment was last modified

contents

Required

string

Text content of the comment

deleted

boolean

Indicates whether the comment has been deleted

isComment

boolean

Indicates whether the item is a comment

object

BaseObject

Class Object

Required

string

Unique identifier of object

created

string

Date and time when the object was created

deleted

boolean

Indicates whether the object is deleted

permDeleted

boolean

Indicates whether the object is permanently deleted

expire

string

Date and time when the object expires and becomes inaccessible

modified

string

Date and time when the object was last modified

name

Required

string

Display name of the object

parentId

Required

string

Parent Folder identifier

userId

Required

string

Unique identifier of Object creator

parent

Folder

Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in "with" parameter)

string

Unique identifier (UUID) of the folder.

parentId

string

Unique identifier (UUID) of the parent object.

name

string

Name of the object.

type

string

Type of the object.
f – File.
d – Folder.

userId

string

Unique identifier (UUID) who created the folder.

creator

object

Details of the user who created the object.

created

string

The date and time when the object was created.

modified

string

The date and time when the object was last modified.

expire

string

Expiration timestamp of the object, if applicable.

permissions

Permission[]

List of permissions associated with the object.

deleted

boolean

Indicates whether the object has been deleted.

permDeleted

boolean

Indicates whether the object has been permanently deleted.

permalink

string

Permanent URL link to access the object.

path

string

Path to the folder in the hierarchy.

members

Member[]

List of members who have access to the object.

vendorDocId

string

Vendor document ID associated with the object.

vendorDocName

string

Name of the vendor document associated with the object.

secure

boolean

Indicates whether the folder or the parent folder containing the file is marked as secure.

source

integer

ID representing the source of the object (1 - Salesforce, 2 - Teams).

isShared

boolean

Indicates if the folder is shared with other users.

syncable

boolean

Indicates if the folder can be synced by Desktop Sync Client.

fileLifetime

integer

Time duration (in days) for which the files in this folder are kept after being added to the folder.

description

string

The description of the folder.

isFavorite

boolean

Indicates if the folder is marked as a favorite by the user.

pushedFilesCount

integer

The number of files that have been pushed to mobile apps in this folder.

currentUserRole

object

The role of the current user in this folder.

avStatus

string

The Antivirus (AV) status of the folder.

dlpStatus

string

The Data Loss Prevention (DLP) status of the folder.

totalMembersCount

integer

Total number of members who have access to this folder.

totalFoldersCount

integer

Total number of subfolders within this folder.

totalFilesCount

integer

Total number of files within this folder.

maxFolderExpiration

string

The maximum expiration date allowed for files in this folder.

maxFileLifetime

integer

The maximum duration (in days) that files in this folder can be kept after being added to the folder.

isLdapGroupMember

boolean

Indicates if the folder is part of an LDAP group.

isUnderMyFolder

boolean

Indicates if this folder is a subfolder of the user's "My Folder".

pathIds

string

A list of IDs representing the path of the folder within the folder hierarchy.

isRoot

boolean

Indicates if this folder is a root folder.

rootId

string

The ID of the root folder if this is a subfolder.

useFolderQuota

boolean

Indicates if a folder quota is applied to this folder.

quota

integer

The storage quota for the folder (in bytes).

size

integer

The total storage size used by the folder (in bytes).

freeSpace

integer

The amount of free space available in the folder (in bytes).

inheritanceEnabled

boolean

Indicates if a folder inherits permissions from the parent folder

permalink

string

Permanent URL for accessing the object in the web application

creator

UserBasicInfo

Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

permissions

Permission[]

Current user's permissions (Explicit field. May be retrieved only if mentioned in "with" parameter)

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

vendorDocId

string

Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

vendorDocName

string

Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

source

integer

Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)

links

string[]

HATEOAS links associated with the entity

author

UserBasicInfo

Author of the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

parent

Comment

Class Comment

Required

integer

Comment unique identifier

parentId

Required

integer

Unique identifier of the parent comment, if the comment is a reply

objectId

Required

string

Unique identifier (UUID) of the file being commented on

folderId

string

Unique identifier (UUID) of the folder containing the object being commented on

userId

Required

string

Unique identifier (UUID) of the user who authored the comment

created

string

Date and time when the comment was created

modified

string

Date and time when the comment was last modified

contents

Required

string

Text content of the comment

deleted

boolean

Indicates whether the comment has been deleted

isComment

boolean

Indicates whether the item is a comment

object

BaseObject

Class Object

Required

string

Unique identifier of object

created

string

Date and time when the object was created

deleted

boolean

Indicates whether the object is deleted

permDeleted

boolean

Indicates whether the object is permanently deleted

expire

string

Date and time when the object expires and becomes inaccessible

modified

string

Date and time when the object was last modified

name

Required

string

Display name of the object

parentId

Required

string

Parent Folder identifier

userId

Required

string

Unique identifier of Object creator

parent

Folder

Folder that directly contains this object (Explicit field. May be retrieved only if mentioned in "with" parameter)

permalink

string

Permanent URL for accessing the object in the web application

creator

UserBasicInfo

Basic profile information of the user who created the object (Explicit field. May be retrieved only if mentioned in "with" parameter)

permissions

Permission[]

Current user's permissions (Explicit field. May be retrieved only if mentioned in "with" parameter)

vendorDocId

string

Identifier of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

vendorDocName

string

Display name of the corresponding document in the external vendor system (Explicit field. May be retrieved only if mentioned in "with" parameter)

source

integer

Numeric code identifying the external system that originated this object (e.g. Salesforce, Teams)

links

string[]

HATEOAS links associated with the entity

author

UserBasicInfo

Author of the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

Required

string

The unique identifier of the user

name

Required

string

The name of the user

Required

string

The user's email

profileIcon

string

URL to the user's profile icon image

parent

Comment

Class Comment

Required

integer

Comment unique identifier

parentId

Required

integer

Unique identifier of the parent comment, if the comment is a reply

objectId

Required

string

Unique identifier (UUID) of the file being commented on

folderId

string

Unique identifier (UUID) of the folder containing the object being commented on

userId

Required

string

Unique identifier (UUID) of the user who authored the comment

created

string

Date and time when the comment was created

modified

string

Date and time when the comment was last modified

contents

Required

string

Text content of the comment

deleted

boolean

Indicates whether the comment has been deleted

isComment

boolean

Indicates whether the item is a comment

object

BaseObject

Class Object

author

UserBasicInfo

Author of the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

parent

Comment

Class Comment

permissions

Permission[]

Permissions of the current user regarding the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

links

string[]

HATEOAS links associated with the entity

permissions

Permission[]

Permissions of the current user regarding the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

links

string[]

HATEOAS links associated with the entity

permissions

Permission[]

Permissions of the current user regarding the comment (Explicit field. May be retrieved only if mentioned in "with" parameter)

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

links

string[]

HATEOAS links associated with the entity

metadata

MetaData

total

integer

Total number of items available.

limit

integer

Maximum number of items returned per page.

offset

integer

Number of items skipped before the current page.

Request blocked by WAF

Empty response body.

Shell

curl -X GET \
  "https://{instance}.kiteworks.com/rest/folders/:id/comments" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

id = "VALUE"  # The unique identifier (UUID) of the folder.

url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/comments"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())

Responses

// Error - No Body

GET/rest/permissions/comment/{comment_id}

Return the list of permissions available on a comment

Returns the list of actions the current user is allowed to perform on the specified comment, such as editing or deleting it.

Parameters

Path Parameters

comment_id

Required

integer

ID of the comment

Query Parameters

Optional

integer

Unique action identifier

id:in

Optional

integer

Unique action identifier. Search for results that match any of the specified values for this parameter.

name

Optional

string

Action name

name:contains

Optional

string

Action name. Search for results that contain the specified characters in this parameter.

allowed

Optional

boolean

Determines if one has permissions to perform action

enabled

Optional

boolean

Determines if the given action is available considering the current object state (locked, deleted, etc.).

with

Optional

string

With parameters

mode

Optional

string

Determines the detail level of the response body.

Responses

Comment permissions retrieved successfully.

data

Permission[]

integer

Unique identifier for the permission.

name

string

Name of the permission.

allowed

boolean

Indicates whether the permission is granted (True) or denied (False).

Request blocked by WAF

Empty response body.

Shell

curl -X GET \
  "https://{instance}.kiteworks.com/rest/permissions/comment/:comment_id" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

comment_id = "VALUE"  # ID of the comment

url = f"https://{{instance}}.kiteworks.com/rest/permissions/comment/{comment_id}"
headers = {
    "Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())

Responses

{ "data": [ { "id": "COMMENT_EDIT", "name": "Edit Comment", "allowed": true } ] }

// Error - No Body

Previousclients

Nextcontacts