部门管理

查询部门

接口描述: 根据传入的信息查询部门

接口地址: https://yd.yunding360.com/openapi/department/findDepartments

请求方式:POST

请求示例:

{
    "name": "",
    "code": "",
    "departmentId": ""
}

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
query query body true DepartmentOpenApiQuery DepartmentOpenApiQuery
page 页码,默认为0 param false int
size 页大小,默认10 param false int

schema属性说明

DepartmentOpenApiQuery

参数名称 参数说明 in 是否必须 数据类型 schema
name 部门名称 body false string
code 部门编号 body false string
departmentId 部门id body false string

响应示例:

{
    "content": [
        {
            "id": "340c33b0-e2f2-11eb-8072-17e9107aab42",
            "createdTime": 1626081544839,
            "creator": null,
            "modifiedTime": null,
            "modifier": null,
            "name": "1121",
            "nameMap": {},
            "enterpriseId": "dd25cef0-3eeb-11e9-9819-7f0037bd9d5c",
            "code": "2121",
            "type": "CUSTOM",
            "parentId": "dd288e10-3eeb-11e9-9819-7f0037bd9d5c",
            "parentName": null,
            "description": null,
            "uuid": "340c33b0-e2f2-11eb-8072-17e9107aab42"
        }
    ],
    "metadata": {
        "size": 1,
        "totalElements": 34,
        "totalPages": 34,
        "page": 0
    }
}

响应参数:

参数名称 参数说明 类型 schema
id ID string(uuid) string(uuid)
createdTime 创建时间 integer(int64) integer(int64)
creator 创建者ID string(uuid) string(uuid)
modifiedTime 最后更新时间 integer(int64) integer(int64)
modifier 更新者ID string(uuid) string(uuid)
name 名称 string
enterpriseId 企业id string
code code string
type 部门类型 SYSTEM:系统,CUSTOM:自定义 enum
parentId 上一级部门id string(uuid)
parentName 上一级部门名称 string
description 描述 string

响应状态:

状态码 说明 schema
200 OK

新增部门

接口地址:https://yd.yunding360.com/openapi/department/add

请求方式:POST

请求数据类型:application/json

请求示例:

{
  "name": "aaa",
  "code": null,
  "parentId": null
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
api-version API版本号,可用值:v1 header true string
Authorization Oauth2认证令牌 header false string
name 部门名称(必填),30个字符以内 body true string
code 部门编号(选填,不能重复,不填写会自动生成) body false string
parentId 上级部门ID(选填) body false string(uuid)

响应状态:

状态码 说明
200 OK

响应参数:

参数名称 参数说明 类型
id id string(uuid)
createdTime 创建时间 long
name 部门名称 string
code 部门编号 string
parentId 上级部门节点id string(uuid)
type 部门类型 string

响应示例:

{
  "id": "a2c72098-1ca3-11ee-ac45-63d3eac9c18a",
  "createdTime": 1688719963149,
  "enterpriseId": "",
  "name": "新增部门",
  "code": "bm111",
  "parentId": "9adf26a0-0b8e-11ec-b9ac-2d2ae93e60ab",
  "type": "CUSTOM"
}

删除部门

接口地址:https://yd.yunding360.com/openapi/department/delete

请求方式:POST

接口描述:可以通过部门id或部门编号删除;如果当前部门有子部门和员工就不能删除

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
api-version API版本号,可用值:v1 header true string
Authorization Oauth2认证令牌 header false string
id 部门id(与code二选一) query false string(uuid)
code 部门编号(与id二选一) query false string

响应状态:

状态码 说明
200 OK

响应参数:

暂无

岗位管理

查询岗位

接口描述: 根据传入的信息查询岗位

接口地址: https://yd.yunding360.com/openapi/roles/findStores

请求方式:POST

请求示例:

{
    "name": "",
    "code": "",
    "roleId": ""
}

请求参数:

参数名称 参数说明 in 是否必须 数据类型 schema
query query body true RoleOpenApiQuery RoleOpenApiQuery
page 页码,默认为0 param false int
size 页大小,默认10 param false int

schema属性说明

RoleOpenApiQuery

参数名称 参数说明 in 是否必须 数据类型 schema
name 岗位名称 body false string
code 岗位编号 body false string
roleId 岗位id body false string

响应示例:

{
    "content": [
        {
            "id": "17826630-eb8d-11eb-9ade-c5f70a86210c",
            "createdTime": 1627027678227,
            "creator": "d003cc20-c34d-11eb-8f7a-cb98ce1b2e37",
            "modifiedTime": 1627553416258,
            "modifier": "9d38e580-9e52-11ea-81c5-43e5ffd660c9",
            "name": "巡店流程管理",
            "nameMap": {},
            "role": "gw259",
            "type": "CUSTOM",
            "enterpriseCode": "huoguo",
            "description": null,
            "constraints": "",
            "uuid": "17826630-eb8d-11eb-9ade-c5f70a86210c"
        }
    ],
    "metadata": {
        "size": 1,
        "totalElements": 132,
        "totalPages": 132,
        "page": 0
    }
}

响应参数:

参数名称 参数说明 类型 schema
id ID string(uuid) string(uuid)
createdTime 创建时间 integer(int64) integer(int64)
creator 创建者ID string(uuid) string(uuid)
modifiedTime 最后更新时间 integer(int64) integer(int64)
modifier 更新者ID string(uuid) string(uuid)
name 名称 string
role 角色code string
type 部门类型 SYSTEM:系统,CUSTOM:自定义 enum
description 描述 string
enterpriseCode 企业code string

响应状态:

状态码 说明 schema
200 OK

新增岗位

接口地址:https://yd.yunding360.com/openapi/roles/add

请求方式:POST

请求数据类型:application/json

请求示例:

{
  "name": "测试新增岗位",
  "role": null,
  "description": null
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
api-version API版本号,可用值:v1 header true string
Authorization Oauth2认证令牌 header false string
name 岗位名称(必填) body true string
role 岗位编号(选填,不能重复,不填写会自动生成) body false string
description 描述(选填) body false string

响应状态:

状态码 说明
200 OK

响应参数:

参数名称 参数说明 类型
id id string(uuid)
createdTime 创建时间 long
name 岗位名称 string
role 岗位编号 string
description 岗位描述 string
type 岗位类型 string

响应示例:

{
  "id": "a2c72098-1ca3-11ee-ac45-63d3eac9c18a",
  "createdTime": 1688719963149,
  "name": "新增岗位",
  "role": "gw111",
  "description": "",
  "type": ""
}

删除岗位

接口地址:https://yd.yunding360.com/openapi/roles/delete

请求方式:POST

接口描述:通过岗位编码或岗位ID进行删除,删除后拥有该岗位权限的账号自动解除关联关系

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型
api-version API版本号,可用值:v1 header true string
Authorization Oauth2认证令牌 header false string
id 岗位id(与code二选一) query false string(uuid)
code 岗位编码(与id二选一) query false string

响应状态:

状态码 说明
200 OK

响应参数:

暂无