Skip to content

Latest commit

 

History

History
181 lines (160 loc) · 5.05 KB

get_service_detail.md

File metadata and controls

181 lines (160 loc) · 5.05 KB
Raw

功能描述

服务详情查询，支持根据指定的服务ID查询服务详情

请求参数

{{ common_args_desc }}

接口参数

字段 类型 必选 描述
service_id int 是 服务id，从服务列表查询中的data["id"]字段获取

请求参数示例

{  
    "bk_app_secret": "xxxx", 
    "bk_app_code": "xxxx", 
    "bk_token": "xxxx", 
    "service_id": 1
}

返回结果示例

{
    "message": "success",
    "code": 0,
    "data": {
        "service_id": 5,
        "workflow_id": 15,
        "name": "test3",
        "service_type": "event",
        "desc": "",
        "fields": [
            {
                "id": 1,
                "key": "title",
                "type": "STRING",
                "name": "标题",
                "desc": "请输入标题",
                "choice": [],
                "validate_type": "REQUIRE",
                "regex": "",
                "meta": {}
            },
            {
                "id": 96,
                "key": "CESHILEIXING",
                "type": "SELECT",
                "name": "测试类型",
                "desc": "",
                "choice": [
                    {
                        "name": "变更",
                        "key": "BIANGENG"
                    },
                    {
                        "name": "请求",
                        "key": "QINGQIU"
                    }
                ],
                "validate_type": "REQUIRE",
                "regex": "EMPTY",
                "meta": {}
            },
            {
                "id": 97,
                "key": "ZIDINGYIBIAOGE",
                "type": "CUSTOMTABLE",
                "name": "自定义表格",
                "desc": "",
                "choice": [],
                "validate_type": "REQUIRE",
                "regex": "EMPTY",
                "meta": {
                    "columns": [
                        {
                            "choice": [],
                            "display": "input",
                            "key": "TEST",
                            "name": "test"
                        },
                        {
                            "choice": [
                                {
                                    "name": "a",
                                    "key": "A"
                                },
                                {
                                    "name": "b",
                                    "key": "B"
                                }
                            ],
                            "display": "select",
                            "key": "TEST2",
                            "name": "test2"
                        }
                    ]
                }
            }
        ]
    },
    "result": true
}

返回结果参数说明

字段 类型 描述
result bool 返回结果，true为成功，false为失败
code int 返回码，0表示成功，其他值表示失败
message string 错误信息
data object 返回数据

data

字段 类型 描述
service_id int 服务id
workflow_id int 服务流程id
name string 服务名称
service_type string 服务类型
desc string 服务描述
fields array 提单字段

fields

字段 类型 描述
id int 字段id
key string 字段唯一标识
type string 字段类型
name string 字段名称
desc string 字段描述
choice array 选项
validate_type string 校验规则
regex string 正则校验规则
meta object 自定义表格格式

type（字段类型）

类型Key 类型
STRING 单行文本
STRING 单行文本
TEXT 多行文本
INT 数字
DATE 日期
DATETIME 时间
DATETIMERANGE 时间间隔
TABLE 表格
SELECT 单选下拉框
MULTISELECT 多选下拉框
CHECKBOX 复选框
RADIO 单选框
MEMBERS 多选人员选择
RICHTEXT 富文本
FILE 附件上传
CUSTOMTABLE 自定义表格
TREESELECT 树形选择
CASCADE 级联

meta

字段 类型 描述
columns array 列

columns

字段 类型 描述
choice array 选项
display string 展现形式
key string 唯一标识
name string 名字