# 企业项目接入

# 1 创建项目接口

# 接口说明

名称	描述
功能	企业通过该接口，可以添加项目到美团企业版系统
HTTP方法	POST
请求方	第三方平台
响应方	美团企业版平台
url	$API_HOST/project/create
method	project.create

# 公共参数

详见：公共参数说明-公共请求参数

# 业务参数

名称	类型	是否必填	示例	说明
costNo	String	是	项目编码	项目编码
costName	String	是	项目名字	项目名字
type	Integer	是	4	项目类型(4:项目)
customField1	String	否	自定义字段1	项目自定义字段1
customField2	String	否	自定义字段2	项目自定义字段2
customField3	String	否	自定义字段3	项目自定义字段3
customField4	String	否	自定义字段4	项目自定义字段4
customField5	String	否	自定义字段5	项目自定义字段5
parentId	String	否	1	项目父级ID
suitableType	Integer	否	2	项目适用类型(1:全员可用;2:部分适用)
managerStaffIds	List	否	[1,2]	项目负责人

# 业务响应

名称	类型	是否非空	示例	说明
costId	String	是	1572215906057064470	项目id

# 示例结果

业务请求

{
    "method":"project.create",
    "ts":1512963578,
    "entId":1,
    "costNo": "项目编码",
    "costName": "项目名称",
    "type": 4,
    "customField1": "自定义字段1",
    "customField2": "自定义字段2",
    "customField3": "自定义字段3",
    "customField4": "自定义字段4",
    "customField5": "自定义字段5",
    "parentId": "1",
    "suitableType": 2,
    "managerStaffIds": [1,2]
}

业务响应

{
    "msg": "",
    "data": {
        "costId": "1572215906057064470"
    },
    "status": 0
}

# 2 更新项目

# 接口说明

名称	描述
功能	企业通过该接口，可以对项目进行修改
HTTP方法	POST
请求方	第三方平台
响应方	美团企业版平台
url	$API_HOST/project/update
method	project.update

# 公共参数

详见：公共参数说明-公共请求参数

# 业务参数

名称	类型	是否必填	示例	说明
costId	String	是	1572215906057064470	项目ID
costNo	String	是	项目编码	项目编码
costName	String	是	项目名字	项目名字
type	Integer	是	4	项目类型(4:项目)
customField1	String	否	自定义字段1	项目自定义字段1
customField2	String	否	自定义字段2	项目自定义字段2
customField3	String	否	自定义字段3	项目自定义字段3
customField4	String	否	自定义字段4	项目自定义字段4
customField5	String	否	自定义字段5	项目自定义字段5
suitableType	Integer	否	2	项目适用类型(1:全员可用;2:部分适用)
managerStaffIds	List	否	[1,2]	项目负责人

# 业务响应

名称	类型	是否非空	示例	说明
data	boolean	是	true	操作是否成功

# 示例结果

业务请求

{
    "method":"project.update",
    "ts":1512963578,
    "entId":1,
    "costId": "1572215906057064470",
    "type": 4,
    "costNo": "项目编码",
    "costName": "项目名称",
    "customField1": "new自定义字段1",
    "customField2": "new自定义字段2",
    "customField3": "new自定义字段3",
    "customField4": "new自定义字段4",
    "customField5": "new自定义字段5",
    "suitableType": 2,
    "managerStaffIds": [1,2]
}

业务响应

{
    "msg": "",
    "data": true,
    "status": 0
}

# 3 查询项目

# 接口说明

名称	描述
功能	企业通过该接口，可以对项目进行查询
HTTP方法	POST
请求方	第三方平台
响应方	美团企业版平台
url	$API_HOST/project/query
method	project.query

# 公共参数

详见：公共参数说明-公共请求参数

# 业务参数

名称	类型	是否必填	示例	说明
costNo	String	否	123	项目编码
costName	String	否	成本中心	项目名字
type	Integer	是	4	项目类型(4:项目)
pageNo	Integer	否	1	分页页码 <=10
pageSize	Integer	否	20	分页大小 <=100
parentId	String	否	1	项目父级ID
statuses	List	否	["ONLINE"]	项目状态

# 业务响应

名称	类型	是否非空	示例	说明
totalCount	Integer	是	100	项目总数
costItemVOS	List<ProjectItemVO>	是	见ProjectItemVO字段说明	项目列表

ProjectItemVO字段说明

名称	类型	是否非空	示例	说明
costId	Long	是	170609	项目ID
costNo	String	是	123	项目编码
type	Integer	是	4	项目类型(4:项目)
costName	String	是	项目中心	项目中心名字
customField1	String	否	自定义字段1	项目自定义字段1
customField2	String	否	自定义字段2	项目自定义字段2
customField3	String	否	自定义字段3	项目自定义字段3
customField4	String	否	自定义字段4	项目自定义字段4
customField5	String	否	自定义字段5	项目自定义字段5
creator	String	是	创建者	创建者
createTime	String	是	2020-06-09 11:11:11	创建时间
parentId	Long	否	1	项目父级ID
costLevel	Integer	否	1	项目层级
status	String	否	ONLINE	项目中心状态(ONLINE:上线，PAUSE:暂停)
managerStaffIds	List	否	[1,2]	项目中心负责人

# 示例结果

业务请求

{
    "method":"project.query",
    "ts":1512963578,
    "entId":1,
    "costNo": "project_code",
    "costName": "项目名称",
    "type": 4,
    "pageNo": 1,
    "pageSize": 20,
    "parentId": 1,
    "statuses": "ONLINE"
}

业务响应

{
    "status": 0,
    "msg": "成功",
    "data": {
        "totalCount": 1,
        "costItemVOS": [
            {
                "costId": "1572215906057064470",
                "costNo": "project_code",
                "type": 4,
                "costName": "项目名称",
                "customField1": "自定义字段1",
                "customField2": "自定义字段2",
                "customField3": "自定义字段3",
                "customField4": "自定义字段4",
                "customField5": "自定义字段5",
                "creator": "100200-api",
                "createTime": "2020-02-05 16:08:36",
                "parentId": 1,
                "costLevel": 2,
                "status": "ONLINE",
                "managerStaffIds": [1,2]
            }
        ]
    }
}

# 4 更新项目状态

# 接口说明

名称	描述
功能	企业通过该接口，可更新项目状态
HTTP方法	POST
请求方	第三方平台
响应方	美团企业版平台
url	$API_HOST/project/updateStatus
method	project.status.update

# 业务参数

名称	类型	是否必填	示例	说明
costId	String	是	170609	项目id
costNo	String	是	project_code	项目编码
type	Integer	是	4	项目类型(4:项目)
status	String	是	ONLINE	项目状态(ONLINE:上线，PAUSE:暂停

# 业务响应

名称	类型	是否非空	示例	说明
data	boolean	是	true	操作是否成功

# 示例结果

业务请求

{
  "method":"project.status.update",
  "ts":1512963578,
  "entId":1,
  "costId": "1572215906057064470",
  "costNo": "project_code",
  "type": 4,
  "status": "ONLINE"
}

业务响应

{
    "status": 0,
    "msg": "成功",
    "data": true
}

# 5 新增项目绑定关系

# 接口说明

名称	描述
功能	企业通过该接口，可以为项目绑定成本/员工关系
HTTP方法	POST
请求方	第三方平台
响应方	美团企业版平台
url	$API_HOST/project/createBind
method	project.create.bind

# 公共参数

详见：公共参数说明-公共请求参数

# 业务参数

名称	类型	是否必填	示例	说明
costId	String	否	123	项目ID
costNo	String	否	123	项目编码(costId和costNo必须有一项为非空)
type	Integer	是	4	项目类型(4:项目)
relatedType	Integer	是	1	绑定类型,0:绑定人员；1:绑定成本
relatedId	String	是	123	被绑定的成本ID/被绑定的员工唯一标识

# 业务响应

名称	类型	是否非空	示例	说明
data	boolean	是	true	操作绑定成功

# 示例结果

业务请求

{
  "method":"project.create.bind",
  "ts":1512963578,
  "entId":1,
  "costId": "1572215906057064470",
  "costNo": "project_code",
  "type": 4,
  "relatedType": 1,
  "relatedId": "123"
}

业务响应

{
    "status": 0,
    "msg": "成功",
    "data": true
}

# 6 删除项目绑定关系

# 接口说明

名称	描述
功能	企业通过该接口，可以为项目删除成本/员工关系
HTTP方法	POST
请求方	第三方平台
响应方	美团企业版平台
url	$API_HOST/project/deleteBind
method	project.delete.bind

# 公共参数

详见：公共参数说明-公共请求参数

# 业务参数

名称	类型	是否必填	示例	说明
costId	String	否	123	项目ID
costNo	String	否	123	项目编码(costId和costNo必须有一项为非空)
type	Integer	是	4	项目类型(4:项目)
relatedType	Integer	是	1	绑定类型,0:绑定人员；1:绑定成本
relatedId	String	是	123	被解绑的成本ID/被绑定的员工唯一标识

# 业务响应

名称	类型	是否非空	示例	说明
data	boolean	是	true	操作解绑成功

# 示例结果

业务请求

{
  "method":"project.delete.bind",
  "ts":1512963578,
  "entId":1,
  "costId": "1572215906057064470",
  "costNo": "project_code",
  "type": 4,
  "relatedType": 1,
  "relatedId": "123"
}

业务响应

{
    "status": 0,
    "msg": "成功",
    "data": true
}

← 企业成本中心接口美团企业版预算中心(老版) →