Help Center/ KooDrive/ API Reference/ API/ Permissions Templates/ Querying Permissions Template Details Based on the Permissions Template ID Array

Updated on 2025-03-14 GMT+08:00

View PDF

Querying Permissions Template Details Based on the Permissions Template ID Array

Function

Query permissions template details based on the permissions template ID array.

URI

POST /koodrive/ose/v1/permission/template/batchGet

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
Authorization	Yes	String	The format is Bearer {app_access_token}. The application-level token needs to be passed for calling by an application server. The token is obtained by calling an API using clientid and clientSecret obtained during application creation.
X-User-Id	Yes	String	User ID, which is used for app authentication.
X-Date	Yes	String	Date, which is used for app authentication.
Host	No	String	Address, which is used for app authentication.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
ids	Yes	Array of longs	Permissions template ID array. 1 ≤ size ≤ 200. The validity of each ID is verified, for example, whether the ID exists.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
code	Integer	Response code.
msg	String	Response information.
data	Array of PermissionTemplate objects	Permissions template information list.

**Table 4** PermissionTemplate
Parameter	Type	Description
id	String	Unique ID of a permissions template.
name	String	Permissions template name.
description	String	Permissions template description.
templateType	Integer	Permissions template type. 0: preset; 1: custom.
status	Integer	Permissions template status. 0: disabled; 1: enabled.
company	String	Enterprise to which the permissions template belongs. The value can be an organization ID or an application ID.
createTime	String	Time when the permissions template is created.
updateTime	String	Time when the permissions template is updated.
capabilities	Capabilities object	Permissions value.

**Table 5** Capabilities
Parameter	Type	Description
addChildNodePermission	Boolean	Permission to create a file or folder. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.
copyPermission	Boolean	Copy permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.
deletePermission	Boolean	Delete permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.
downloadPermission	Boolean	Download permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.
editPermission	Boolean	Edit permissions. true: granted; false: not granted (editing is not supported.)
listChildNodePermission	Boolean	Permission to view the list. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.
removeChildNodePermission	Boolean	Move permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.
renameFilePermission	Boolean	Rename permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.
shareFilePermission	Boolean	Share permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.
uploadPermission	Boolean	Upload permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.
viewPermission	Boolean	Preview permission. The value true indicates that the permission is granted, and the value false indicates that the permission is not granted.

Example Requests

/koodrive/ose/v1/permission/template/batchGet

{
  "ids" : [ "1590626552448551681" ]
}

Example Responses

Status code: 200

Response body.

{
  "data" : [ {
    "id" : "******",
    "name" : "File List, Preview, Download, and Share",
    "description" : "File list, preview, download, and share.",
    "templateType" : 1,
    "status" : 1,
    "company" : "*******",
    "createTime" : "2024-12-19T07:59:34.032Z",
    "updateTime" : "2024-12-19T07:59:57.786Z",
    "capabilities" : {
      "addChildNodePermission" : false,
      "copyPermission" : false,
      "deletePermission" : false,
      "downloadPermission" : true,
      "editPermission" : false,
      "listChildNodePermission" : true,
      "removeChildNodePermission" : false,
      "renameFilePermission" : false,
      "shareFilePermission" : true,
      "uploadPermission" : false,
      "viewPermission" : true
    }
  } ],
  "code" : 0,
  "msg" : "success"
}