Help Center/ KooDrive/ API Reference/ API/ Space Management/ Querying Information About a Team Space
Updated on 2024-07-30 GMT+08:00

Querying Information About a Team Space

Function

Query information about a team space.

URI

GET /koodrive/ose/v1/space/teamList

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

offset

Yes

Integer

Offset. Minimum value: 0.

limit

Yes

Integer

Maximum number of records to be returned. Value range: 1 to 100.

keyWord

No

String

Search keyword. You can use name and ownerNamer as the search criteria.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

Access token. Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}.

X-Traceid

No

String

Message log trace ID. The value contains 58 bits.

language

No

String

Language code, which complies with the internationalization specifications. For example, en-US indicates English (United States). English (United States) is used by default.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

String

Error code.

msg

String

Error message.

total

String

Total number of records.

teams

Array of TeamSpaceInfo objects

Team space list.

Table 4 TeamSpaceInfo

Parameter

Type

Description

id

String

ID of the department, user group, or group to which the space belongs.

groupName

String

Team space name, which is a department or user group name.

status

Integer

Space status.

capacity

Integer

Space size.

spaceUsed

String

Size of the used space.

containerId

String

Space ID.

userNum

Integer

Number of users.

ownerId

String

Owner ID.

ownerName

String

Owner name.

tenantId

String

Tenant ID.

creator

String

Creator.

createTime

String

Creation time.

modifier

String

ID of the user who updated the information.

updateTime

String

Update time.

bizRootFileId

String

ID of the space root directory.

bizSboxFileId

String

ID of the space safe directory.

iconUrl

String

Icon link.

top

Integer

Whether this record is pinned to top.

role

Integer

Role.

deptNamePath

String

Department location.

Example Requests

Queries the space information of team 369528171409614001.

GET /koodrive/ose/v1/space/teamList

Authorization:Bearer+10f88**********4791e9ff

Example Responses

Status code: 200

Space information.

{
  "data" : {
    "tenantId" : "40086000004871666",
    "creator" : "369528171409614001",
    "createTime" : "2023-11-07T20:36:35.000Z",
    "modifier" : "369528171409614001",
    "updateTime" : "2023-12-26T11:40:07.000Z",
    "ownerId" : "369528171409614001",
    "type" : 1,
    "status" : 0,
    "capacity" : 800,
    "spaceUsed" : 91966408,
    "containerId" : "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4",
    "rootFileId" : "HFFdIb642fU51JWKAUlP6mwUVc8oDNKbO",
    "bizRootFileId" : "DEUI7pa0C24ArootIAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4",
    "bizSboxFileId" : "DEUI7pa0C24AsboxIAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4"
  },
  "code" : 0,
  "msg" : "OK"
}

Status Codes

Status Code

Description

200

Space information.