Spendia开放接口

增量查询部门列表

接口描述

此接口为增量接口用于按照部门最后变更日期查询部门。

接口权限

本接口需要集团权限

接口权限

/api/openapi/departments

请求URI

GET

请求参数示例

/api/openapi/departments?startTime=2020-06-04 00:00:00&endTime=2020-06-04 23:59:59&baseDate=2021-03-03&page=1&size=2

请求参数说明

パラメータ名 タイプ 必須 説明
startTime String ○ 検索スタート日時。フォーマット: yyyy-MM-dd HH:mm:ss
endTime String ○ 検索エンド日時。フォーマット: yyyy-MM-dd HH:mm:ss
page int ○ ページ、第一ページ: page=1
size int ○ ページごとの結果数。最大50
baseDate String 否 基准日：yyyy-MM-dd

接口返回示例

{
    "total": 2,
    "current": 1,
    "pageSize": 20,
    "pages": 1,
    "hasPrevious": false,
    "hasNext": false,
    "data": [
        {
            "name": "技术一部",
            "departmentOID": "fc030840-5e59-47b5-b58c-7b8014785cd5",
            "path": "技术部|技术一部",
            "code": "TEC-1",
            "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"
                }
            ]
        },
        {
            "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"
                }
            ]
        }
    ]
}

接口返回字段

PageResposne

参数名 类型 说明
total int 查询结果总个数
current int 当前页数
pageSize int 每页结果计
pages int 查询结果总分页数
hasPrevious boolean 是否有上一页
hasNext boolean 是否有下一页
data Department[] 部门数据

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"
}

字段说明

字段名称 类型 说明
message String 返回信息说明
errorCode String 返回错误码

错误代码

errorCode message 说明
4002 无效的分页参数:{0}
4003 时间格式为:{0}
6013009 日期格式为:yyyy-MM-dd
120001 当前操作需要租户权限
120003 缺少必填项:{0}

← 查询部门 →