Updated on 2024-07-30 GMT+08:00

Querying a Department

Function

Query the information about a department.

URI

GET /koodrive/ose/v1/departments/{department_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

department_id

Yes

String

Department ID.

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

Response code.

msg

String

Response information.

id

String

Department ID.

orgId

String

ID of the organization created in OrgID.

deptId

String

ID of the department created in OrgID.

parentId

String

ID of the parent department in KooDrive.

name

String

Department name.

tenantId

String

Tenant ID.

Example Requests

Queries information about department 1319678187126486144.

GET /koodrive/ose/v1/departments/1319678187126486144

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

Example Responses

Status code: 200

Department information.

{
  "id" : "1319678187126486144",
  "orgId" : "9190086000001210958",
  "deptId" : "a4fd0d798f5344ccac2c695646ef66d3",
  "parentId" : "1245640257345455489",
  "name" : "test16",
  "tenantId" : "40086000004871666",
  "code" : 0,
  "msg" : "success"
}

Status Codes

Status Code

Description

200

Department information.