open-api

创建项目

CBD测试环境

https://cbdtest.yitaiyitai.com/bpmax/open-api

POST

/project/create

请求参数

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

可选

默认值:

Body 参数application/json

project_id

string | null

父项目id

可选

子流程项目被父流程项目拉起时创建子项目需要指定此字段为父项目id

step_id

string | null

父项目环节id

可选

子流程项目被父流程项目拉起时父项目所在的环节id，如业务上无需区分则可以传0

client_token

string

校验token

可选

用于幂等性校验（如果携带client_token请求，第一次会成功创建项目，第二次后之后的创建都会失败，token的有效期是24小时）

flow_key

string

必需

flow_type

string

必需

workspace

string

必需

form

object

必需

key_to_value

object

必需

user_id

string

必需

示例

{
        "flow_key": "",
        "flow_type": "flow523597057",
        "workspace": "operate",
        "form": {
                "key_to_value": {
                        "address": "四川省成都市金牛区",
                        "expectOpenDate": 1703001600000,
                        "franchiseeMobile": "18328498308",
                        "franchiseeName": "wj-13",
                        "siteSelectionCode": "2312200006"
                }
        },
        "user_id": "1",
        "client_token": "111-aaa"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://cbdtest.yitaiyitai.com/bpmax/open-api/project/create' \
--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' \
--header 'Content-Type: application/json' \
--data-raw '{
        "flow_key": "",
        "flow_type": "flow523597057",
        "workspace": "operate",
        "form": {
                "key_to_value": {
                        "address": "四川省成都市金牛区",
                        "expectOpenDate": 1703001600000,
                        "franchiseeMobile": "18328498308",
                        "franchiseeName": "wj-13",
                        "siteSelectionCode": "2312200006"
                }
        },
        "user_id": "1",
        "client_token": "111-aaa"
}'

返回响应

🟢200成功

application/json

Body

object {0}

示例

{}

修改于 2024-10-09 09:29:16

批量导入项目

环节流转