组织查询 - 组织人事

请求参数

Body 参数application/json

codeList

array[string]

编号

可选

ids

array[number]

组织id（部门/分部）

可选

typeList

array[string]

组织类型

可选

类型： department 部门、subcompany 分部

containDisableOrg

boolean

含停用部门

可选

containExtend

boolean

包含自定义（分部/部门）

可选

current

integer

分页-当前页

可选

pageSize

integer

分页-页大小

可选

最大1000

parentCodeList

array[string]

上级组织编号

可选

可以是分部或者部门的编号；与parentOrgIds参数冲突；如果设置当前参数，则parentOrgIds无效

parentOrgIds

array[number]

上级组织id

可选

可以是分部或者部门

loadAllChilds

boolean

是否含下级

可选

仅支持 parentCodeList 或者 parentOrgIds

subcompanyCodeList

array[string]

所属分部编号列表

可选

与subcompanyList参数冲突；如果设置当前参数，则subcompanyList无效

subcompanyList

array[number]

所属分部id列表

可选

multiFieldList

array[string]

需要返回的多语言字段

可选

仅支持： name 名称；fullname 全称

createTime

object

创建日期

可选

创建日期-开始、创建日期-结束不能同时为空 ; 日期格式： yyyy-MM-dd HH:mm:ss

from

string

创建日期-开始

可选

to

string

创建日期-结束

可选

updateTime

object

修改日期

可选

修改日期-开始、修改日期-结束不能同时为空日期格式： yyyy-MM-dd HH:mm:ss

from

string

修改日期-开始

可选

to

string

修改日期-结束

可选

virtualId

string

虚拟维度

可选

虚拟维度id ; 2504基线后支持；不提供默认查询行政维度

nameList

array[string]

名称查询列表

可选

按照精确的名称查询

nameLikeList

array[string]

模糊名称查询列表

可选

模糊查询

示例

{
    "typeList": [
        "department"
    ],
    "codeList": [
        "145403"
    ],
    "ids": [
        977668748719054853
    ],
    "containDisableOrg": true,
    "containExtend": true,
    "current": 1,
    "pageSize": 1000,
    "parentCodeList": [
        "977654407840030722"
    ],
    "parentOrgIds": [
        "977654407840030722"
    ],
    "loadAllChilds": true,
    "subcompanyCodeList": [],
    "subcompanyList": [],
    "multiFieldList": [
        "name",
        "fullname"
    ]
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/hrm/restful/queryOrg' \
--header 'Content-Type: application/json' \
--data-raw '{
    "typeList": [
        "department"
    ],
    "codeList": [
        "145403"
    ],
    "ids": [
        977668748719054853
    ],
    "containDisableOrg": true,
    "containExtend": true,
    "current": 1,
    "pageSize": 1000,
    "parentCodeList": [
        "977654407840030722"
    ],
    "parentOrgIds": [
        "977654407840030722"
    ],
    "loadAllChilds": true,
    "subcompanyCodeList": [],
    "subcompanyList": [],
    "multiFieldList": [
        "name",
        "fullname"
    ]
}'

返回响应

🟢200成功

application/json

Body

message

object

必需

errcode

string

必需

errmsg

string

必需

data

object

必需

current

integer

当前页

必需

total

integer

总数

必需

当前查询总数

data

array [object {16}]

必需

pageSize

integer

页大小

必需

示例

{
    "message": {
        "errcode": "0",
        "errmsg": "success"
    },
    "data": {
        "current": 1,
        "total": 37,
        "data": [
            {
                "parent": "2226184113543634646",
                "code": "FBBH20221109004",
                "tenant_key": "t7emfkqmmm",
                "invisible": false,
                "type": "subcompany",
                "has_sub": false,
                "id": "778456985568411648",
                "virtualid": "1",
                "disporder": 1,
                "subcompanyid": "778456985568411648",
                "datarank": 2,
                "is_delete": false,
                "name": "华为",
                "status": true
            },
            {
                "parent": "778456985568411648",
                "code": "BMBH20221007002",
                "tenant_key": "t7emfkqmmm",
                "invisible": false,
                "type": "department",
                "has_sub": false,
                "id": "781254508442632193",
                "virtualid": "1",
                "disporder": 0,
                "subcompanyid": "778456985568411648",
                "datarank": 3,
                "formdata": "782788580537442305",
                "is_delete": false,
                "name": "行政部",
                "status": true
            }
        ],
        "pageSize": 0
    }
}