查询部门

接口描述

此接口为按照部门编码查询部门信息.

接口权限

本接口需要集团权限

请求URI

/api/openapi/department

请求方式

GET

请求参数示例

  • /api/openapi/department?departmentCode=TEC-1&baseDate=xxxx
  • /api/openapi/department?departmentOID=58516027-c0c9-420a-aedf-f9d74ca4b2ed&fromDate=xxxx

请求参数说明

departmentCode和departmentOID二选一

参数名 类型 是否必填 说明
departmentCode String 部门编码。最大长度36
departmentOID UUID 部门OID
baseDate String 基准日 日期格式:yyyy-MM-dd

接口返回示例

{
    "name": "技术二部",
    "departmentOID": "fc030840-5e59-47b5-b58c-7b8014785cd5",
    "path": "技术部|技术二部",
    "code": "TEC-2",
    "status": 101,
    "companyCode": "COM002",
    "parentOID": "d1bea8a6-bbef-40d2-bf1d-5ee724a01ca6",
    "fromDate": "2021-03-03",
    "toDate": "2021-03-04",
    "customFields": [
        {
            "fieldCode": "country",
            "value": "AE"
        },
        {
            "fieldCode": "gender",
            "value": "1"
        }
    ]
}

接口返回字段

Department

参数名 类型 规则 说明
name String 最大长度 50 部门名称
departmentOID UUID 长度 36 部门OID
path String 最大长度 1000 部门路径
code String 最大长度 36 部门编码
status int 101--启用;102--禁用 部门状态
companyCode String 最大长度35 所属公司
parentOID UUID 长度36 父部门OID
fromDate String 日期格式:yyyy-MM-dd 开始日期
toDate String 日期格式:yyyy-MM-dd 结束日期
customFields CustomFields[] 部门自定义字段列表

CustomFields

参数名 类型 说明
fieldCode String 自定义字段编码
value String 自定义字段值

失败示例

{
    "message": "当前操作需要租户权限",
    "errorCode": "120001"
}

错误代码说明

errorCode message 说明
6013009 日期格式为:yyyy-MM-dd
120001 当前操作需要租户权限