新建自定义模板
功能介绍
新建自定义模板
调用方法
请参见如何调用API。
URI
POST /v4/{project_id}/versions/{version_uri}/custom-template
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID |
|
version_uri |
是 |
String |
版本uri |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
feature_uris |
否 |
Array of strings |
特性uri |
|
template_name |
否 |
String |
模板名称 |
|
template_uri |
否 |
String |
模板uri |
|
column_configs |
否 |
Array of ReportTemplateColumnConfig objects |
模板配置 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
filter |
否 |
LogicFilterOperator object |
过滤项 |
|
column_name |
否 |
String |
字段名称 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
logic_operator |
否 |
String |
逻辑操作 |
|
field_name |
否 |
String |
字段名 |
|
field_name_key |
否 |
String |
字段名key |
|
field_value |
否 |
String |
字段值 |
|
field_value_key |
否 |
String |
字段值key |
|
field_operator |
否 |
String |
字段操作 |
|
logic_filters |
否 |
Array of LogicFilterOperator objects |
逻辑过滤 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
success|error |
|
result |
ResultValueString object |
请求的返回的数据对象 |
|
error |
ApiError object |
失败时的error信息 |
|
request_id |
String |
由接口调用方传入，建议使用UUID保证请求的唯一性。 |
|
server_address |
String |
本次请求的受理的服务地址 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 |
|
value |
String |
实际的数据类型：单个对象，集合 或 NULL |
|
reason |
String |
业务失败的提示内容 |
|
page_size |
Integer |
分页大小 |
|
page_no |
Integer |
分页编码 |
|
has_more |
Boolean |
是否有更多 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
接口调用失败错误码 |
|
error_msg |
String |
接口调用失败错误信息 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
接口调用失败错误码 |
|
error_msg |
String |
接口调用失败错误信息 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
接口调用失败错误码 |
|
error_msg |
String |
接口调用失败错误信息 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
接口调用失败错误码 |
|
error_msg |
String |
接口调用失败错误信息 |
请求示例
post https://{endpoint}/v4/f3087a82b44744c29a1bd69ab6ada154/versions/12sdsz21/custom-template
{
"template_name" : "新建模板1",
"template_uri" : "12338288s"
}
响应示例
状态码：200
OK
{
"status" : "ok",
"result" : {
"value" : true
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
