Querying Problem Type Template
Function
Query the corresponding template of a problem type.
URI
GET /v2/servicerequest/config/templates
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
business_type_id |
Yes |
String |
Specifies the service type ID. Minimum length: 1 Maximum length: 64 |
Request 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
Parameter |
Type |
Description |
---|---|---|
total_count |
Integer |
Specifies the total number. Minimum value: 0 Maximum value: 65535 |
incident_template_list |
Array of IncidentTempV2 objects |
Specifies the template list. |
Parameter |
Type |
Description |
---|---|---|
incident_template_id |
String |
Specifies the template ID. Minimum length: 1 Maximum length: 64 |
incident_template_name |
String |
Specifies the template name. Minimum length: 1 Maximum length: 64 |
incident_template_content |
String |
Specifies the template content. Minimum length: 1 Maximum length: 128 |
Request Example
GET https://{endpoint}/v2/servicerequest/config/templates?incident_business_type_id=123 null
Response Example
Status code: 200
Code 200 is returned if the operation is successful.
{ "total_count" : 1, "incident_template_list" : [ { "incident_template_id" : "123", "incident_template_name" : "Bank transfer creation template", "incident_template_content" : "|- Account ID: Bank transfer description: " } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Code 200 is returned if the operation is successful. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.