项目详情 - open-api

请求参数

Path 参数

id

string

必需

示例值:

994633571

Header 参数

x-bp-corporation-id

string

v2客户唯一标识

可选

默认值:

x-bp-app-id

string

v2应用id

可选

默认值:

x-bp-timestamp

string

v2签名时间戳

可选

默认值:

x-bp-sign

string

v2签名

可选

默认值:

x-open-api-secret

string

可选

v1验签秘钥，v1和v2版本同时存在时使用v2版本校验

默认值:

Cookie 参数

cbd_test.yitaiyitai.com_mms

string

可选

默认值:

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://cbdtest.yitaiyitai.com/bpmax/open-api/project/994633571' \
--header 'x-bp-corporation-id: {{OPEN_CORPORATION_ID}}' \
--header 'x-bp-app-id: {{OPEN_APP_ID}}' \
--header 'x-bp-timestamp: {{TIME_STAMP}}' \
--header 'x-bp-sign: {{SIGN}}' \
--header 'x-open-api-secret: cbdtest_yitaiyitai_com^asdasd%wpocm@noirfeoopmciuoi23' \
--header 'Cookie: cbd_test.yitaiyitai.com_mms=35df455d-1ad2-456d-b521-77d7fc0552f0'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

object (项目实体)

必需

id

integer

项目id

必需

name

string

可选

项目名称(大部分使用自定义表单创建的项目已经没有此字段，都是存在metaForm内找)

status

enum<number>

必需

0 未开始 1 进行中 2 完结 3 延期 4 失败, 5 暂停

枚举值:

012345

create_time

string

项目创建时间

必需

update_time

string

项目最近更新时间

必需

plan_end_time

string

项目计划结束时间

可选

real_start_time

string

项目实际开始时间

必需

real_end_time

string

项目实际结束时间

可选

start_step_id

integer

项目开始的环节id

必需

start_flow_step_id

string

必需

项目开始的流程节点id

end_step_id

string

可选

触发项目结束环节id(只有项目状态为已结束时此字段才有意义)

end_flow_step_id

string

可选

触发项目结束的流程节点id(只有项目状态为已结束时此字段才有意义)

user_id

integer

项目创建人id

必需

owner_id

integer

项目负责人id

必需

project_id

integer

必需

父项目id，为0表示没有父级项目

step_id

string

必需

父项目拉起当前项目时所处的环节，为0表示为项目详情页面拉起

key

string

子流程标识

必需

flow_type

string

主流程标识

必需

metaForm

object (表单)

项目表单

必需

steps

array[object (环节实体) {20}]

必需

示例

{
    "code": 0,
    "message": "string",
    "data": {
        "id": 0,
        "name": "string",
        "status": 0,
        "create_time": "string",
        "update_time": "string",
        "plan_end_time": "string",
        "real_start_time": "string",
        "real_end_time": "string",
        "start_step_id": 0,
        "start_flow_step_id": "string",
        "end_step_id": "string",
        "end_flow_step_id": "string",
        "user_id": 0,
        "owner_id": 0,
        "project_id": 0,
        "step_id": "string",
        "key": "string",
        "flow_type": "string",
        "metaForm": {
            "key_to_value": {
                "[key:string]": "string"
            },
            "title_to_value": {
                "[title: string]": "string"
            },
            "field_to_value": {
                "[field: string]": "string"
            },
            "value": [
                "string"
            ]
        },
        "steps": [
            {
                "id": 0,
                "name": "string",
                "from_flow_step_id": "string",
                "flow_step_id": "string",
                "accept_start_time": "string",
                "real_start_time": "string",
                "step_alive_time": "string",
                "plan_start_time": "string",
                "real_end_time": "string",
                "plan_end_time": "string",
                "status": 0,
                "delay_level": 0,
                "create_time": "string",
                "update_time": "string",
                "user_id": 0,
                "project_id": 0,
                "form_template_id": 0,
                "owner": [
                    {
                        "id": 0,
                        "name": "string",
                        "avatar": "string",
                        "status": 0,
                        "step_id": 0,
                        "limit_start_time": null,
                        "limit_end_time": null,
                        "attr": null,
                        "organization_id": 0,
                        "models": [
                            "string"
                        ],
                        "role": [
                            {
                                "name": "string",
                                "key": "string",
                                "user_id": 0
                            }
                        ]
                    }
                ],
                "formList": [
                    {
                        "key_to_value": {
                            "[key:string]": "string"
                        },
                        "title_to_value": {
                            "[title: string]": "string"
                        },
                        "field_to_value": {
                            "[field: string]": "string"
                        },
                        "value": [
                            "string"
                        ]
                    }
                ],
                "period": "string"
            }
        ]
    }
}