open-api
    open-api
    • 通过用户手机号获取用户基本信息
      GET
    • 项目详情
      GET
    • 修改项目表单
      PUT
    • 批量导入项目
      POST
    • 创建项目
      POST
    • 环节流转
      PUT
    • 子项目列表
      GET
    • [es]查询项目列表
      POST
    • 获取团队详情
      GET
    • 环节流转前校验
      GET
    • [es]项目详情
      POST
    • 修改项目基本信息
      PUT
    • 流程信息
      GET
    • 获取外部登录token
      POST
    • [es]查询项目列表 Copy
      POST
    • 获取上传文件临时token
      POST
    • 获取项目表单
      POST
    • 项目变动事件回调
      POST

      [es]查询项目列表

      测试中
      CBD测试环境
      https://cbdtest.yitaiyitai.com/bpmax/open-api
      CBD测试环境
      https://cbdtest.yitaiyitai.com/bpmax/open-api
      POST
      /project/es/search
      查询es索引中的项目数据,其中请求参数中的 flow_type, flow_key, data_set_key为固定参数
      data_set_key可由头像侧边栏 "数据集管理" 入口进入,对应的流程数据集列表中的key查询到
      返回值 _source 中文档中标明的字段为所有流程项目固定返回的属性,其他字段需要根据特定业务场景定制

      请求参数

      Header 参数
      x-bp-corporation-id
      string 
      v2客户唯一标识
      可选
      默认值:
      {{OPEN_CORPORATION_ID}}
      x-bp-app-id
      string 
      v2应用id
      可选
      默认值:
      {{OPEN_APP_ID}}
      x-bp-timestamp
      string 
      v2签名时间戳
      可选
      默认值:
      {{TIME_STAMP}}
      x-bp-sign
      string 
      v2签名
      可选
      默认值:
      {{SIGN}}
      x-open-api-secret
      string 
      可选
      v1验签秘钥,v1和v2版本同时存在时使用v2版本校验
      默认值:
      {{OPEN_API_SECRET_KEY}}
      Cookie 参数
      cbd_test.yitaiyitai.com_mms
      string 
      可选
      默认值:
      {{COOKIE}}
      Body 参数application/json
      flow_type
      string 
      主流程标识
      必需
      flow_key
      string 
      子流程标识
      必需
      data_set_key
      string 
      数据集key
      必需
      body
      string  | integer  | boolean  | array  | object  | number  | null 
      es搜索条件
      必需
      https://www.elastic.co/guide/en/elasticsearch/reference/6.6/search-request-body.html
      示例
      {
          "data_set_key": "zhengshuguanli",
          "flow_type": "flow781388777",
          "flow_key": "",
          "body": {
              "query": {
                  "bool": {
                      "must": [
                          {
                              "match_phrase": {
                                  "serialNumber": "d4s56dds-7EFE06"
                              }
                          }
                      ]
                  }
              }
          }
      }

      示例代码

      Shell
      JavaScript
      Java
      Swift
      Go
      PHP
      Python
      HTTP
      C
      C#
      Objective-C
      Ruby
      OCaml
      Dart
      R
      请求示例请求示例
      Shell
      JavaScript
      Java
      Swift
      curl --location --request POST 'https://cbdtest.yitaiyitai.com/bpmax/open-api/project/es/search' \
      --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 '{
          "data_set_key": "zhengshuguanli",
          "flow_type": "flow781388777",
          "flow_key": "",
          "body": {
              "query": {
                  "bool": {
                      "must": [
                          {
                              "match_phrase": {
                                  "serialNumber": "d4s56dds-7EFE06"
                              }
                          }
                      ]
                  }
              }
          }
      }'

      返回响应

      🟢201成功
      application/json
      Body
      code
      integer 
      必需
      message
      string 
      必需
      data
      object 
      返回值
      必需
      took
      integer 
      es原生返回字段
      必需
      timed_out
      boolean 
      es原生返回字段
      必需
      _shards
      object 
      es原生返回字段
      必需
      hits
      object 
      es原生返回字段
      必需
      示例
      {
          "code": 0,
          "message": "success",
          "data": {
              "took": 0,
              "timed_out": false,
              "_shards": {
                  "total": 1,
                  "successful": 1,
                  "skipped": 0,
                  "failed": 0
              },
              "hits": {
                  "total": {
                      "value": 1,
                      "relation": "eq"
                  },
                  "max_score": 1,
                  "hits": [
                      {
                          "_index": "8dyte1grx7li",
                          "_id": "994634711",
                          "_score": 1,
                          "_source": {
                              "__id": 994634711,
                              "__p_id": 994634710,
                              "__is_del": 0,
                              "__create_time": "2023-12-16T09:35:46.000Z",
                              "__update_time": "2023-12-16T09:44:41.000Z",
                              "__owner_id": 995916066,
                              "__workspace": "xunjian",
                              "__visibility": "public",
                              "__visibility_user": [],
                              "__visibility_group": [],
                              "parent_id": 994634710,
                              "ding_shi_repeate_count": 0,
                              "ding_shi_description": "自2023年12月16日起 每天17:35:01创建一次项目持续到 2023年12月23日 00:00:00",
                              "ding_shi_end_time": "2023-12-23 00:00:00",
                              "ding_shi_start_time": "2023-12-16 17:35:01",
                              "__all_owner_ids": [
                                  1,
                                  2,
                                  3
                              ],
                              "__step_owners": [
                                  {
                                      "project_id": 994634711,
                                      "step_id": 0,
                                      "flow_step_id": "1699097966747",
                                      "owner_id": 995916068,
                                      "id": 995916068,
                                      "name": "王冰冰",
                                      "phone": "xxx",
                                      "avatar": "",
                                      "email": ""
                                  },
                                  {
                                      "project_id": 994634711,
                                      "step_id": 0,
                                      "flow_step_id": "1699097966747",
                                      "owner_id": 995916127,
                                      "id": 995916127,
                                      "name": "蒙恬",
                                      "phone": "xx",
                                      "avatar": "",
                                      "email": ""
                                  },
                                  {
                                      "project_id": 994634711,
                                      "step_id": 0,
                                      "flow_step_id": "1699097966747",
                                      "owner_id": 995916109,
                                      "id": 995916109,
                                      "name": "姜宽",
                                      "phone": "xxx2",
                                      "avatar": "",
                                      "email": ""
                                  },
                                  {
                                      "project_id": 994634711,
                                      "step_id": 0,
                                      "flow_step_id": "1699097966747",
                                      "owner_id": 995916136,
                                      "id": 995916136,
                                      "name": "二飞",
                                      "phone": "18485507608",
                                      "avatar": "",
                                      "email": null
                                  },
                                  {
                                      "project_id": 994634711,
                                      "step_id": 999536287,
                                      "flow_step_id": "1696820336087",
                                      "owner_id": 995916068,
                                      "id": 995916068,
                                      "name": "店小二",
                                      "phone": "xx",
                                      "avatar": "",
                                      "email": ""
                                  },
                                  {
                                      "project_id": 994634711,
                                      "step_id": 999536287,
                                      "flow_step_id": "1696820336087",
                                      "owner_id": 995916127,
                                      "id": 995916127,
                                      "name": "赵信",
                                      "phone": "xx",
                                      "avatar": "",
                                      "email": ""
                                  },
                                  {
                                      "project_id": 994634711,
                                      "step_id": 999536287,
                                      "flow_step_id": "1696820336087",
                                      "owner_id": 995916109,
                                      "id": 995916109,
                                      "name": "姜",
                                      "phone": "xx",
                                      "email": ""
                                  },
                                  {
                                      "project_id": 994634711,
                                      "step_id": 999536287,
                                      "flow_step_id": "1696820336087",
                                      "owner_id": 995916136,
                                      "id": 995916136,
                                      "name": "二飞",
                                      "phone": "18485507608",
                                      "avatar": "",
                                      "email": null
                                  },
                                  {
                                      "project_id": 994634711,
                                      "step_id": 999536290,
                                      "flow_step_id": "1696820368942",
                                      "owner_id": 1,
                                      "id": 1,
                                      "name": "杨翰文",
                                      "phone": "xxx",
                                      "avatar": "",
                                      "email": ""
                                  },
                                  {
                                      "project_id": 994634711,
                                      "step_id": 999536290,
                                      "flow_step_id": "1696820368942",
                                      "owner_id": 995916135,
                                      "id": 995916135,
                                      "name": "一飞",
                                      "phone": "sdazx",
                                      "avatar": "",
                                      "email": null
                                  },
                                  {
                                      "project_id": 994634711,
                                      "step_id": 999536290,
                                      "flow_step_id": "1696820368942",
                                      "owner_id": 995916066,
                                      "id": 995916066,
                                      "name": "武奔",
                                      "phone": "xxx",
                                      "avatar": "",
                                      "email": ""
                                  },
                                  {
                                      "project_id": 994634711,
                                      "step_id": 999536290,
                                      "flow_step_id": "1696820368942",
                                      "owner_id": 995916118,
                                      "id": 995916118,
                                      "name": "武小奔",
                                      "phone": "12333",
                                      "avatar": "",
                                      "email": ""
                                  },
                                  {
                                      "project_id": 994634711,
                                      "step_id": 999536292,
                                      "flow_step_id": "1696820372475",
                                      "owner_id": 995916127,
                                      "id": 995916127,
                                      "name": "蒙恬",
                                      "phone": "442",
                                      "avatar": "",
                                      "email": ""
                                  }
                              ],
                              "__project_owner": {
                                  "id": 995916066,
                                  "name": "xx",
                                  "avatar": "",
                                  "email": ""
                              },
                              "current_flow_step_id": "1696820372475",
                              "zhi_xing_zhong_step_start_time": 1702719350000,
                              "dian_ping_step_end_time": 1702719881000,
                              "zhi_xing_zhong_step_end_time": 1702719530000,
                              "dian_ping_step_start_time": 1702719530000,
                              "current_step_owner_list": 995916127,
                              "men_dian": {
                                  "name": "北京营运中心回龙观龙域中心万科昌发展1店",
                                  "id": "sad"
                              },
                              "ke_zhi_xing_start_time": 1702656000000,
                              "xun_jian_ren": [
                                  {
                                      "id": 995916068,
                                      "is_admin": 0,
                                      "name": "王冰冰",
                                      "avatar": ""
                                  },
                                  {
                                      "id": 995916127,
                                      "is_admin": 0,
                                      "name": "蒙恬",
                                      "avatar": ""
                                  },
                                  {
                                      "id": 995916109,
                                      "is_admin": 0,
                                      "name": "姜宽",
                                      "avatar": ""
                                  },
                                  {
                                      "id": 995916136,
                                      "is_admin": 0,
                                      "name": "二飞",
                                      "avatar": ""
                                  }
                              ]
                          }
                      }
                  ]
              }
          }
      }
      修改于 2024-12-10 06:43:24
      上一页
      子项目列表
      下一页
      获取团队详情
      Built with