Querying Additional Parameters

Updated on 2025-02-10 GMT+08:00

View PDF

Function

When submitting a trouble ticket, you need to set some additional parameters based on the product or problem type.

URI

GET /v2/servicerequest/config/extends-map

**Table 1** Query parameters
Parameter	Mandatory	Type	Description
business_type_id	Yes	String	Specifies the service type ID. Minimum length: 1 Maximum length: 64
incident_sub_type_id	No	String	Specifies the service ticket subtype ID. Minimum length: 1 Maximum length: 64
product_category_id	No	String	Specifies the product type ID. Minimum length: 1 Maximum length: 64

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Minimum length: 1 Maximum length: 5000
X-Language	No	String	Specifies the language environment. The value is a common language description character string, for example, zh-cn. It is zh-cn by default. Some internationalization information, such as the service ticket type and name, is displayed based on the language environment. Minimum length: 1 Maximum length: 32
X-Time-Zone	No	String	Specifies the time zone. The value is a common time zone description character string, for example, GMT+8. It is GMT+8 by default. Time-related data is processed based on the time zone of the environment. Minimum length: 1 Maximum length: 32

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
extends_params	Array of ExtendsParamV2 objects	Specifies the list of additional parameters.
common_params	Array of CommonParamV2 objects	Specifies the list of public additional parameters.

**Table 4** ExtendsParamV2
Parameter	Type	Description
tips	String	Specifies the tips. Minimum length: 0 Maximum length: 128
required	Integer	Specifies whether it is mandatory or not. Minimum value: 0 Maximum value: 1
length	Integer	Specifies the limited length. Minimum value: 0 Maximum value: 65535
language	String	Specifies the language. Minimum length: 1 Maximum length: 32
param_key	String	Specifies the parameter ID. Minimum length: 1 Maximum length: 32
param_name	String	Specifies the parameter name. Minimum length: 1 Maximum length: 32
param_type	Integer	Specifies the parameter type. Minimum value: 0 Maximum value: 10
param_desc	String	Description of the parameter. Minimum length: 0 Maximum length: 128
default_value	String	Specifies the default value. Minimum length: 0 Maximum length: 64
max_value	Long	Specifies the maximum value. Minimum value: 0 Maximum value: 9223372036854775807
min_value	Long	Specifies the minimum value. Minimum value: 0 Maximum value: 9223372036854775807
select_item	String	Specifies the option value. Minimum length: 0 Maximum length: 5000
is_show	Integer	Indicates whether it is displayed or not. Minimum value: 0 Maximum value: 1
is_sensitive	Integer	Indicates whether it is sensitive or not. Minimum value: 0 Maximum value: 1

**Table 5** CommonParamV2
Parameter	Type	Description
param_key	String	Specifies the parameter ID. Minimum length: 1 Maximum length: 32
param_name	String	Specifies the parameter name. Minimum length: 1 Maximum length: 32
is_show	Integer	Indicates whether it is displayed or not. Minimum value: 0 Maximum value: 1
is_required	Integer	Specifies whether it is mandatory or not. Minimum value: 0 Maximum value: 1

Request Example

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

null

Response Example

Status code: 200

Code 200 is returned if the operation is successful.

{
  "extends_params" : {
    "tips" : "Please enter",
    "required" : 1,
    "length" : 32,
    "language" : "zh-cn",
    "param_key" : "ecs_instance_id",
    "param_name" : "ECS instance ID",
    "param_type" : 0,
    "param_desc" : "ECS instance 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" : "ECS instance ID",
    "is_show" : 1,
    "is_required" : 1
  }
}