查询附加参数

功能介绍

提单时，根据不同的产品或者问题类型，会存在不同的一些附加参数填写

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/servicerequest/config/extends-map

表1 Query参数
参数	是否必选	参数类型	描述
business_type_id	是	String	业务类型id 最小长度：1 最大长度：32
incident_sub_type_id	否	String	工单子类型id 最小长度：1 最大长度：32
product_category_id	否	String	产品类型id 最小长度：1 最大长度：64

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。最小长度：1 最大长度：5000
X-Language	否	String	语言环境，值为通用的语言描述字符串，比如zh-cn等，默认为zh-cn。会根据语言环境对应展示一些国际化的信息，比如工单类型名称等。最小长度：1 最大长度：32
X-Time-Zone	否	String	环境时区，值为通用的时区描述字符串，比如GMT+8等，默认为GMT+8。涉及时间的数据会根据环境时区处理。最小长度：1 最大长度：32

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
extends_params	Array of ExtendsParamV2 objects	附加参数列表数组长度：0 - 65535
common_params	Array of CommonParamV2 objects	公共附加参数列表数组长度：0 - 65535

表4 ExtendsParamV2
参数	参数类型	描述
tips	String	提示最小长度：0 最大长度：128
required	Integer	是否必填最小值：0 最大值：1
length	Integer	限制长度最小值：0 最大值：65535
language	String	语言最小长度：1 最大长度：32
param_key	String	参数标识最小长度：1 最大长度：32
param_name	String	参数名称最小长度：1 最大长度：32
param_type	Integer	参数类型整数1，单行文本3，单选4，多选5，协议7，多行文本8 最小值：0 最大值：10
param_desc	String	参数描述最小长度：0 最大长度：128
default_value	String	默认值最小长度：0 最大长度：64
max_value	Long	最大值最小值：0 最大值：9223372036854775807
min_value	Long	最小值最小值：0 最大值：9223372036854775807
select_item	String	选项值最小长度：0 最大长度：5000
is_show	Integer	是否展示最小值：0 最大值：1
is_sensitive	Integer	是否敏感最小值：0 最大值：1
param_subtype	Integer	参数子类
param_subtype_value	String	参数子类的值
regex	String	正则表达式校验值
create_time	Timestamp	创建时间
update_time	Timestamp	更新时间
creator_id	String	创建人id
updator_id	String	修改人id
relative_cloud_service	String	关联云服务

表5 CommonParamV2
参数	参数类型	描述
param_key	String	参数标识最小长度：1 最大长度：32
param_name	String	参数名称最小长度：1 最大长度：32
is_show	Integer	是否展示最小值：0 最大值：1
is_required	Integer	是否必填最小值：0 最大值：1

请求示例

GET https://{endpoint}/v2/servicerequest/config/extends-map

null

响应示例

状态码： 200

成功返回200

{
  "extends_params" : {
    "tips" : "请填写",
    "required" : 1,
    "length" : 32,
    "language" : "zh-cn",
    "param_key" : "ecs_instance_id",
    "param_name" : "弹性云主机实例id",
    "param_type" : 0,
    "param_desc" : "弹性云主机实例id",
    "default_value" : null,
    "max_value" : null,
    "min_value" : null,
    "select_item" : null,
    "is_show" : 1,
    "is_sensitive" : 1
  },
  "common_params" : {
    "param_key" : "ecs_instance_id",
    "param_name" : "弹性云主机实例id",
    "is_show" : 1,
    "is_required" : 1
  }
}