Department

Manages department organizational unit creation, modification, and hierarchical structure maintenance, etc

---

Query the list of department

GET

/api/v1/dept

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

Department id.

类型integer

格式"int64"

code

Department code.

类型string

name

Department name.

类型string

pid

Parent department id.

类型integer

格式"int64"

level

Department level.

类型integer

格式"int32"

tagId

Department association tag id.

类型integer

格式"int64"

createdBy

Department creation user id.

类型integer

格式"int64"

createdDate

Department creation date.

类型string

格式"date-time"

pageNo

Page data size, default 1, maximum 100000

类型integer

格式"int32"

最大值100000

最小值1

pageSize

Page data size, default 10, maximum 2000

类型integer

格式"int32"

最大值2000

最小值1

orderBy

Sort field

类型string

orderSort

Sorting method

类型string

有效值

"ASC""DESC"

filters[0].key

Filter field name

类型string

filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

有效值

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

Filter value

filters[1].key

Filter field name

类型string

filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

有效值

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

Filter value

filters[2].key

Filter field name

类型string

filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

有效值

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

Filter value

infoScope

Query information scope

类型string

有效值

"BASIC""DETAIL"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/dept

试验场

服务器

授权

UserHttpBearer

变量

键

值

id

code

name

pid

level

tagId

createdBy

createdDate

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

Replace departments

PUT

/api/v1/dept

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

[

{

"id": 1,

"name": "MarketingDepartment",

"code": "HR",

"pid": -1,

"tagIds": [

0

]

}

]

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/dept

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Add departments

POST

/api/v1/dept

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

[

{

"name": "MarketingDepartment",

"code": "HR",

"pid": 0,

"tagIds": [

0

]

}

]

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/dept

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Delete departments

DELETE

/api/v1/dept

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

ids*

Department ids

类型array

必填

最大项数200

最小项数0

唯一项true

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

DELETE

/api/v1/dept

试验场

服务器

授权

UserHttpBearer

变量

键

值

ids*

示例

cURL

JavaScript

PHP

Python

---

Update departments

PATCH

/api/v1/dept

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

[

{

"id": 1,

"name": "MarketingDepartment",

"code": "HR",

"pid": "DEFAULT_ROOT_PID",

"tagIds": [

0

]

}

]

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PATCH

/api/v1/dept

试验场

服务器

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Query the detail of department

GET

/api/v1/dept/{id}

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Department id

类型integer

必填

格式"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/dept/{id}

试验场

服务器

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Query the navigation position of department tree

GET

/api/v1/dept/{id}/navigation

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Department id

类型integer

必填

格式"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/dept/{id}/navigation

试验场

服务器

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Query the number of sub departments and department users number

GET

/api/v1/dept/{id}/count

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

id*

Department id

类型integer

必填

格式"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/dept/{id}/count

试验场

服务器

授权

UserHttpBearer

变量

键

值

id*

示例

cURL

JavaScript

PHP

Python

---

Fulltext search the list of department

GET

/api/v1/dept/search

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

Department id.

类型integer

格式"int64"

code

Department code.

类型string

name

Department name.

类型string

pid

Parent department id.

类型integer

格式"int64"

level

Department level.

类型integer

格式"int32"

tagId

Department association tag id.

类型integer

格式"int64"

createdBy

Department creation user id.

类型integer

格式"int64"

createdDate

Department creation date.

类型string

格式"date-time"

pageNo

Page data size, default 1, maximum 100000

类型integer

格式"int32"

最大值100000

最小值1

pageSize

Page data size, default 10, maximum 2000

类型integer

格式"int32"

最大值2000

最小值1

orderBy

Sort field

类型string

orderSort

Sorting method

类型string

有效值

"ASC""DESC"

filters[0].key

Filter field name

类型string

filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

有效值

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

Filter value

filters[1].key

Filter field name

类型string

filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

有效值

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

Filter value

filters[2].key

Filter field name

类型string

filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

有效值

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

Filter value

infoScope

Query information scope

类型string

有效值

"BASIC""DETAIL"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/dept/search

试验场

服务器

授权

UserHttpBearer

变量

键

值

id

code

name

pid

level

tagId

createdBy

createdDate

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---