您好，请问需要什么帮助？

快速入门、使用手册、常见问题

项目

目录

创建项目 #

该接口用于创建项目。

请求方式：POST

请求地址：https://api.bjx.cloud/openapi/projects

请求数据格式：application/json

请求体：

{
    "operatorId": 1023,
    "code": "abc",
    "name": "测试项目",
    "preCode": "abc",
    "owner": 1023,
    "projectTypeId": 0,
    "publicStatus": 1,
    "remark": "测试",
    "memberIds": [1023],
    "isAllMember": false,
    "followerIds": [1023],
    "isSyncOutCalendar": 2
}

请求参数说明：

参数类型是否必传说明
operatorIdlongy操作人
codestringn项目code
namestringy项目名
preCodestringy项目前缀code，唯一
ownerlongy项目负责人
projectTypeIdlongn通用项目或者敏捷项目，默认通用
publicStatusinty项目公开状态，1：公共，2：私有
remarkstringn备注
memberIds[]longn成员列表
isAllMemberbooln成员是否包含企业所有人

响应体：

{
    "code": 0,
    "message": "",
    "data": {
        "id": 1753,
        "orgId": 1004,
        "code": "",
        "name": "测试项目2",
        "preCode": "abcabcabc",
        "owner": 1023,
        "projectTypeId": 1,
        "planStartTime": "1970-01-01 00:00:00",
        "planEndTime": "1970-01-01 00:00:00",
        "publicStatus": 1,
        "resourceId": 0,
        "isFiling": 2,
        "remark": "测试",
        "creator": 1023,
        "createTime": "2021-01-11 14:17:27",
        "updator": 1023,
        "updateTime": "2021-01-11 14:17:27",
        "version": 1,
        "isDelete": 2
    }
}

响应参数说明:

参数类型说明
codeint错误码，非0表示失败
messagestring错误描述
data––
∟idlong项目id
∟orgIdlong企业id
∟codestring项目code
∟namestring项目名
∟preCodestring项目前缀编号
∟ownerlong负责人
∟projectTypeIdlong项目类型id
∟planStartTimestring计划开始时间
∟planEndTimestring计划结束时间
∟publicStatusint项目公开状态，1：公有，2：私有
∟resourceIdlong项目资源id
∟isFillingint归档状态，1：归档，2：未归档
∟remarkstring备注
∟creatorlong创建人
∟createTimestring创建时间
∟updatorlong更新人
∟updateTimestring更新时间

项目列表 #

该接口用于查询项目列表。

请求方式：POST

请求地址：https://api.bjx.cloud/openapi/projects/filter?page=1

请求数据格式：application/json

请求体：

{
    "id":177,
    "name":"a",
    "owner":3307,
    "projectTypeId":1,
    "isFiling":1,
    "statusType":1,
    "creatorIds":[1111],
    "ownerIds":[11111],
    "relateType":1,
    "participants":[1111],
    "participantDeptIds":[1231],
    "isMember":1
}

请求参数说明：

路径参数：

参数类型是否必传说明
pageintn页码（query传递），默认值：1，若要查询全部传0
sizeintn分页大小（query传递），默认值：10，若要查询全部传0

请求体：

参数类型是否必传说明
operatorIdlongn当前操作人id（用于下面的relateType,isMember这些字段）
idlongn项目id
namestringn项目名
ownerlongn项目负责人id
projectTypeIdlongn1通用项目，2敏捷项目
isFilingintn是否归档1归档，2未归档，3全部，默认全部
statusTypeintn项目状态1未开始，2进行中，3已完成，4未完成
creatorIds[]longn创建人id集合
ownerIds[]longn负责人id集合
relateTypeintn关联类型（配合operatorId使用）： 0所有，1我发起的，2我负责的，3我参与的，4我负责的和我参与到，5我关注的
participants[]longn参与人id集合
participantDeptIds[]longn参与部门id集合
isMemberintn是否是成员（配合operatorId使用）：1是2否

响应体：

{
    "code": 0,
    "message": "",
    "data": {
        "total": 7,
        "list": [
            {
                "id": 2777,
                "orgId": 1242,
                "code": "",
                "name": "这话的阿哈迪斯",
                "preCode": "ZHDAHDS",
                "owner": 3307,
                "projectTypeId": 1,
                "priorityId": 0,
                "planStartTime": null,
                "planEndTime": null,
                "publicStatus": 1,
                "resourceId": 3874,
                "isFiling": 2,
                "remark": "",
                "status": 2,
                "statusType": 2,
                "creator": 3307,
                "createTime": "2021-01-25 21:32:23",
                "updator": 3307,
                "updateTime": "2021-01-25 21:34:15",
                "version": 1,
                "isDelete": 2,
                "creatorInfo": {
                    "id": 3307,
                    "userId": 3307,
                    "name": "文小兰",
                    "namePy": "WenXiaoLan",
                    "avatar": "https://s3-fs.pstatp.com/static-resource/v1/b1dfe7f3-2b41-4903-8530-2f33f9d6006g~?image_size=noop&cut_type=&quality=&format=png&sticker_format=.webp",
                    "emplId": "",
                    "unionId": "",
                    "isDeleted": false,
                    "isDisabled": false
                },
                "ownerInfo": {
                    "id": 3307,
                    "userId": 3307,
                    "name": "文小兰",
                    "namePy": "WenXiaoLan",
                    "avatar": "https://s3-fs.pstatp.com/static-resource/v1/b1dfe7f3-2b41-4903-8530-2f33f9d6006g~?image_size=noop&cut_type=&quality=&format=png&sticker_format=.webp",
                    "emplId": "",
                    "unionId": "",
                    "isDeleted": false,
                    "isDisabled": false
                },
                "memberInfo": [
                    {
                        "id": 3307,
                        "userId": 3307,
                        "name": "文小兰",
                        "namePy": "WenXiaoLan",
                        "avatar": "https://s3-fs.pstatp.com/static-resource/v1/b1dfe7f3-2b41-4903-8530-2f33f9d6006g~?image_size=noop&cut_type=&quality=&format=png&sticker_format=.webp",
                        "emplId": "",
                        "unionId": "",
                        "isDeleted": false,
                        "isDisabled": false
                    }
                ],
                "followerInfo": [],
                "resourcePath": "https://polaris-hd2.oss-cn-shanghai.aliyuncs.com/front_resources/general_project_cover_x1.png?x-oss-process=style/thumbnail_001",
                "resourceCompressedPath": "https://polaris-hd2.oss-cn-shanghai.aliyuncs.com/front_resources/general_project_cover_x1.png?x-oss-process=style/thumbnail_001",
                "allIssues": 2,
                "finishIssues": 0,
                "overdueIssues": 1,
                "iterationStat": {
                    "id": 0,
                    "name": "",
                    "allIssues": 2,
                    "overdueIssues": 1,
                    "finishIssues": 0
                },
                "allStatus": [
                    {
                        "id": 2,
                        "name": "进行中",
                        "displayName": "",
                        "bgStyle": "#F1A102",
                        "fontStyle": "#F1A102",
                        "type": 2,
                        "sort": 0
                    },
                    {
                        "id": 3,
                        "name": "已完成",
                        "displayName": "",
                        "bgStyle": "#25B47E",
                        "fontStyle": "#25B47E",
                        "type": 3,
                        "sort": 0
                    }
                ],
                "projectTypeName": "普通任务项目",
                "projectTypeLangCode": "ProjectType.NormalTask",
                "isSyncOutCalendar": 20,
                "isStar": 0,
                "relateUnfinish": 0,
                "projectObjectTypeList": [
                    {
                        "id": 0,
                        "langCode": "Project.ObjectType.Task",
                        "name": "任务",
                        "objectType": 2,
                        "processId": 0
                    }
                ]
            }
        ]
    }
}

响应参数说明:

参数类型说明
codeint错误码，非0表示失败
messagestring错误描述
data––
∟totalint项目数量
∟list[]object项目列表
∟idlong项目id
∟orgIdlong企业id
∟codestring项目code
∟namestring项目名
∟preCodestring项目前缀编号
∟ownerlong负责人
∟projectTypeIdlong项目类型id
∟planStartTimestring计划开始时间
∟planEndTimestring计划结束时间
∟publicStatusint项目公开状态，1：公有，2：私有
∟resourceIdlong项目资源id
∟isFillingint归档状态，1：归档，2：未归档
∟remarkstring备注
∟creatorlong创建人
∟createTimestring创建时间
∟updatorlong更新人
∟updateTimestring更新时间
∟creatorInfouserInfo创建人信息
∟userIdlong负责人id
∟namestring负责人姓名
∟namePystring姓名拼音版
∟avatarstring头像
∟isDeletedbool是否已离职
∟isDisabledbool是否已禁用
∟ownerInfouserInfo负责人信息
∟memberInfo[]userInfo项目成员信息
∟resourcePathstring项目封面
∟resourceCompressedPathstring项目封面缩略图
∟allIssuesint任务数量
∟finishIssuesint已完成的任务数量
∟overdueIssuesint逾期的任务数量
∟iterationStatobject正在进行中的迭代信息
∟idlong迭代id
∟namestring迭代名称
∟allIssuesint任务数量
∟finishIssuesint已完成的任务数量
∟overdueIssuesint逾期的任务数量
∟allStatus[]object项目所有状态
∟idint状态id
∟namestring状态名称
∟displayNamestring状态名称
∟bgStylestring背景色
∟fontStylestring字体色
∟sortstring排序
∟projectTypeNamestring项目类型名称
∟projectTypeLangCodestring项目类型编号
∟isSyncOutCalendarint是否同步到飞书日历(4：负责人，8：关注人，12：关注人+负责人。1包含了关注人和负责人；2表示都不包含。)
∟isStarint是否星标（配合传入的operatorId），1表示打星，0否
∟relatedUnFinishint与我相关的未完成的所有任务数量
∟projectObjectTypeList[]object任务栏
∟idintid
∟langCodestring编号
∟namestring名称
∟objectTypeint类型1迭代2任务
∟processIdint流程id

查询项目 #

该接口用于查询单个项目。

请求方式：GET

请求地址：https://api.bjx.cloud/openapi/projects/${projectId}

请求数据格式：*/*

响应体：

{
    "code": 0,
    "message": "",
    "data": {
        "id": 2777,
        "orgId": 1242,
        "code": "",
        "name": "这话的阿哈迪斯",
        "preCode": "ZHDAHDS",
        "owner": 3307,
        "projectTypeId": 1,
        "priorityId": 0,
        "planStartTime": "1970-01-01 00:00:00",
        "planEndTime": "1970-01-01 00:00:00",
        "publicStatus": 1,
        "resourceId": 3874,
        "isFiling": 2,
        "remark": "",
        "status": 2,
        "creator": 3307,
        "createTime": "2021-01-25 21:32:23",
        "updator": 3307,
        "updateTime": "2021-01-25 21:32:23",
        "creatorInfo": {
            "id": 3307,
            "userId": 3307,
            "name": "文小兰",
            "namePy": "WenXiaoLan",
            "avatar": "https://s3-fs.pstatp.com/static-resource/v1/b1dfe7f3-2b41-4903-8530-2f33f9d6006g~?image_size=noop&cut_type=&quality=&format=png&sticker_format=.webp",
            "emplId": "",
            "unionId": "",
            "isDeleted": false,
            "isDisabled": false
        },
        "ownerInfo": {
            "id": 3307,
            "userId": 3307,
            "name": "文小兰",
            "namePy": "WenXiaoLan",
            "avatar": "https://s3-fs.pstatp.com/static-resource/v1/b1dfe7f3-2b41-4903-8530-2f33f9d6006g~?image_size=noop&cut_type=&quality=&format=png&sticker_format=.webp",
            "emplId": "",
            "unionId": "",
            "isDeleted": false,
            "isDisabled": false
        },
        "memberInfo": [
            {
                "id": 3307,
                "userId": 3307,
                "name": "文小兰",
                "namePy": "WenXiaoLan",
                "avatar": "https://s3-fs.pstatp.com/static-resource/v1/b1dfe7f3-2b41-4903-8530-2f33f9d6006g~?image_size=noop&cut_type=&quality=&format=png&sticker_format=.webp",
                "emplId": "",
                "unionId": "",
                "isDeleted": false,
                "isDisabled": false
            }
        ],
        "memberDepartmentInfo": [],
        "followerInfo": null,
        "resourcePath": "https://polaris-hd2.oss-cn-shanghai.aliyuncs.com/front_resources/general_project_cover_x1.png",
        "allStatus": [
            {
                "id": 2,
                "name": "进行中",
                "displayName": "",
                "bgStyle": "#F1A102",
                "fontStyle": "#F1A102",
                "type": 2,
                "sort": 0
            },
            {
                "id": 3,
                "name": "已完成",
                "displayName": "",
                "bgStyle": "#25B47E",
                "fontStyle": "#25B47E",
                "type": 3,
                "sort": 0
            }
        ],
        "isSyncOutCalendar": 20,
        "syncCalendarStatusList": [
            4,
            16
        ],
        "isCreateFsChat": 1,
        "isStar": 0
    }
}

响应参数说明:

参数类型说明
codeint错误码，非0表示失败
messagestring错误描述
data––
∟idlong项目id
∟orgIdlong企业id
∟codestring项目code
∟namestring项目名
∟preCodestring项目前缀编号
∟ownerlong负责人
∟projectTypeIdlong项目类型id
∟planStartTimestring计划开始时间
∟planEndTimestring计划结束时间
∟publicStatusint项目公开状态，1：公有，2：私有
∟resourceIdlong项目资源id
∟isFillingint归档状态，1：归档，2：未归档
∟remarkstring备注
∟creatorlong创建人
∟createTimestring创建时间
∟updatorlong更新人
∟updateTimestring更新时间
∟creatorInfouserInfo创建人信息
∟userIdlong负责人id
∟namestring负责人姓名
∟namePystring姓名拼音版
∟avatarstring头像
∟isDeletedbool是否已离职
∟isDisabledbool是否已禁用
∟ownerInfouserInfo负责人信息
∟memberInfo[]userInfo项目成员信息
∟resourcePathstring项目封面
∟resourceCompressedPathstring项目封面缩略图
∟allIssuesint任务数量
∟finishIssuesint已完成的任务数量
∟overdueIssuesint逾期的任务数量
∟iterationStatobject正在进行中的迭代信息
∟idlong迭代id
∟namestring迭代名称
∟allIssuesint任务数量
∟finishIssuesint已完成的任务数量
∟overdueIssuesint逾期的任务数量
∟allStatus[]object项目所有状态
∟idint状态id
∟namestring状态名称
∟displayNamestring状态名称
∟bgStylestring背景色
∟fontStylestring字体色
∟sortstring排序
∟projectTypeNamestring项目类型名称
∟projectTypeLangCodestring项目类型编号
∟isSyncOutCalendarint是否同步到飞书日历(4：负责人，8：关注人，12：关注人+负责人。1包含了关注人和负责人；2表示都不包含。)
∟isStarint是否星标（配合传入的operatorId），1表示打星，0否
∟isCreateFsChatint是否创建了飞书群聊1是2否

更新项目 #

该接口用于项目更新。

请求方式：PUT

请求地址：https://api.bjx.cloud/openapi/projects/${projectId}

请求数据格式：application/json

请求体：

{
    "operatorId":3123 ,
    "name":"刘狗狗狗狗狗",
    "owner":1882,
    "publicStatus":2,
    "remark":"shnme",
    "memberIds":[1882,1883],
    "memberForDepartmentId":[867368],
    "syncCalendarStatusList":[4,8,16],
    "iaAllMember":false,
    "isCreateFsChat":1
}

请求参数说明：

参数类型是否必传说明
operatorIdlongy操作人
namestringn项目名称
ownerlongn负责人id
publicStatusintn项目公开性,1公开,2私有
remarkstringn项目描述
memerIds[]longn项目成员用户id集合
memberForDepartmentId[]longn项目成员部门id集合（里面包含0的话表示全部成员）
syncCalendarStatusList[]intn同步到其飞书日历(4：同步给负责人，8：同步给关注人。16:同步到订阅日历)
isCreateFsChatintn是否创建群聊（针对于飞书1是2否默认是）

响应体：

{
    "code": 0,
    "message": "",
    "data": {
        "id": 8193
    }
}

响应参数说明:

参数类型说明
codeint错误码，非0表示失败
messagestring错误描述
data––
∟idlong项目id

删除项目 #

该接口用于创建项目。

请求方式：DELETE

请求地址：https://api.bjx.cloud/openapi/projects/${projectId}

请求数据格式：*/*

请求体：

{
    "operatorId": 1023
}

请求参数说明：

参数类型是否必传说明
operatorIdlongy操作人

响应体：

{
    "code": 0,
    "message": "",
    "data": {
        "id": 8193
    }
}

响应参数说明:

参数类型说明
codeint错误码，非0表示失败
messagestring错误描述
data––
∟idlong项目id

任务统计 #

该接口用于查询项目任务统计。

请求方式：GET

请求地址：https://api.bjx.cloud/openapi/projects/${projectId}/stats?operatorId=${operatorId}&relateType=1

请求数据格式：*/*

请求参数说明：

参数类型是否必传说明
operatorIdlongn操作人
projectIdlongy项目id（0表示所有项目）
relateTypeintn关联类型（配合operatorId使用。1我创建的2我负责的3我参与的4我关注的5我确认的）

响应体：

{
    "code": 0,
    "message": "",
    "data": {
        "notStartTotal": 58,
        "processingTotal": 0,
        "completedTotal": 0,
        "completedTodayTotal": 0,
        "overdueTotal": 0,
        "overdueTomorrowTotal": 0,
        "overdueCompletedTotal": 0,
        "total": 58,
        "overdueTodayTotal": 0,
        "beAboutToOverdueSum": 0,
        "todayCount": 0,
        "todayCreateCount": 0,
        "callMeTotal": 0,
        "list": [
            {
                "name": "已逾期",
                "count": 0
            },
            {
                "name": "进行中",
                "count": 0
            },
            {
                "name": "未完成",
                "count": 58
            },
            {
                "name": "已完成",
                "count": 0
            }
        ]
    }
}

响应参数说明:

参数类型说明
codeint错误码，非0表示失败
messagestring错误描述
data––
∟notStartTotalint未开始的任务数
∟processingTotalint进行中的任务数
∟completedTotalint已完成的任务数
∟completedTodayTotalint今日完成的任务数
∟overdueTotalint逾期的任务数
∟overdueTomorrowTotalint明日逾期的任务数
∟overdueCompletedTotalint逾期完成的任务数
∟totalint任务总数
∟overdueTodayTotalint今日逾期的任务数
∟beAboutToOverdueSumint即将逾期的任务数
∟todayCountint今日指派给我的任务数
∟todayCreateCountint今日创建的任务数
∟callMeTotalint艾特我的数量
∟listarray所有状态任务数
∟namestring任务状态名称
∟countint数量
在线客服
联系电话
400 138 5281
我们将在24小时内尽快联系您
取消