模板REST API功能¶
介绍¶
功能模板REST API允许对功能模板和模板层规则执行CRUD操作。
模板配置¶
/rest/featurestemplates
查找全局中的所有模板 (features-templating )目录或在全局目录中创建新模板。
方法 |
消费 |
生产 |
行动 |
支持的参数 |
响应 |
|---|---|---|---|---|---|
GET |
应用程序/XML、应用程序/json。 |
中所有可用模板的列表 |
|
||
POST |
应用程序/xml、文本/xml、应用程序/json、文本/json、应用程序/xhtml+xml、应用程序/压缩。 |
文本/纯文本。 |
将请求正文(文本或压缩文件)中的模板作为新模板添加到 |
模板名称(发布原始模板时必填，发布压缩文件时可选) |
|
/rest/workspaces/<workspace name>/featurestemplates
在中查找所有模板 workspace 目录中创建新模板或在 workspace 目录。
方法 |
消费 |
生产 |
行动 |
支持的参数 |
响应 |
|---|---|---|---|---|---|
GET |
应用程序/XML、应用程序/json。 |
中所有可用模板的列表 |
|
||
POST |
应用程序/xml、文本/xml、应用程序/json、文本/json、应用程序/xhtml+xml、应用程序/压缩。 |
文本/纯文本。 |
将请求正文(文本或压缩文件)中的模板作为新模板添加到 |
模板名称(发布原始模板时必填，发布压缩文件时可选) |
|
/rest/workspaces/<workspace name>/featuretypes/<featureType name>/featurestemplates
在中查找所有模板 featuretype 目录中创建新模板或在 featuretype 目录。
方法 |
消费 |
生产 |
行动 |
支持的参数 |
响应 |
|---|---|---|---|---|---|
GET |
应用程序/json、应用程序/xml。 |
中所有可用模板的列表 |
|
||
POST |
应用程序/xml、文本/xml、应用程序/json、文本/json、应用程序/xhtml+xml、应用程序/压缩。 |
文本/纯文本。 |
将请求正文(文本或压缩文件)中的模板作为新模板添加到 |
模板名称(发布原始模板时必填，发布压缩文件时可选) |
|
/rest/featurestemplates/<template name>
如果具有指定名称的模板存在于全局 (features-templating )目录中，返回模板或将模板内容替换为请求正文中的内容。
方法 |
消费 |
生产 |
行动 |
响应 |
|---|---|---|---|---|
GET |
应用程序/xml、应用程序/json、应用程序/xhtml+xml。 |
具有指定名称的模板(如果在 |
|
|
PUT |
应用程序/xml、文本/xml、应用程序/json、文本/json、应用程序/xhtml+xml、应用程序/压缩。 |
文本/纯文本。 |
替换模板(如果在 |
|
DELETE |
删除模板(如果在 |
/rest/workspaces/<workspace name>/featurestemplates/<template name>
如果具有指定名称的模板存在于 workspace 目录，则返回模板或将模板内容替换为请求正文中的内容。
方法 |
消费 |
生产 |
行动 |
响应 |
|---|---|---|---|---|
GET |
应用程序/xml、应用程序/json、应用程序/xhtml+xml。 |
具有指定名称的模板(如果在 |
|
|
PUT |
应用程序/xml、文本/xml、应用程序/json、文本/json、应用程序/xhtml+xml、应用程序/压缩。 |
文本/纯文本。 |
替换现有模板(如果在 |
|
DELETE |
删除模板(如果在 |
/rest/workspaces/<workspace name>/featuretypes/<featureType name>
/featurestemplates/<template name>
如果具有指定名称的模板存在于 featuretype 目录，则返回模板或将模板内容替换为请求正文中的内容。
方法 |
消费 |
生产 |
行动 |
响应 |
|---|---|---|---|---|
GET |
应用程序/xml、应用程序/json、应用程序/xhtml+xml。 |
具有指定名称的模板(如果在 |
|
|
PUT |
应用程序/xml、文本/xml、应用程序/json、文本/json、应用程序/xhtml+xml、应用程序/压缩。 |
文本/纯文本。 |
替换现有模板(如果在 |
|
DELETE |
删除模板(如果在 |
模板规则配置¶
/rest/workspaces/<workspace name>/featuretypes/<featureType name>/templaterules
查找所有已配置的模板规则 featuretype 或者创造一个新的。
方法 |
消费 |
生产 |
行动 |
响应 |
|---|---|---|---|---|
GET |
应用程序/XML、应用程序/json。 |
可用于的所有模板规则列表 |
|
|
POST |
应用程序/XML、文本/XML、应用程序/json、文本/json。 |
文本/纯文本。 |
在请求体中添加模板规则。 |
|
/rest/workspaces/<workspace name>/featuretypes/<featureType name>
/templaterules/<rule identifier>
查找、替换、更新或删除具有指定标识符的模板规则。
方法 |
消费 |
生产 |
行动 |
响应 |
|---|---|---|---|---|
GET |
应用程序/XML、应用程序/json。 |
具有指定的 |
|
|
PUT |
应用程序/XML、文本/XML、应用程序/json、文本/json。 |
文本/纯文本。 |
将具有指定ID的规则替换为请求正文中提供的ID。 |
|
PATCH |
应用程序/XML、文本/XML、应用程序/json、文本/json。 |
文本/纯文本。 |
允许使用请求正文中提供的规则中指定的字段部分更新具有指定ID的规则。它使用一个 JSON merge patch like strategy |
|
DELETE |
删除具有指定ID的规则。 |
数据对象传输¶
数据对象的传输同时支持XML和JSON。
XML：：中模板规则的编码
<Rule>
<ruleId>..</ruleId>
<priority>..</priority>
<templateName>..</templateName>
<outputFormat>..</outputFormat>
<cqlFilter>..</cqlFilter>
<profileFilter>...</profileFilter>
</Rule>
JSON：：中规则的编码
{"Rule": {"ruleId":..,"priority":..,"templateName":"..","outputFormat":"..","cqlFilter":"..","profileFilter":".."}}
在应用部分更新时，传入对象中缺少的属性/元素将保持不变。属性可以设置为空。例如，下面的示例将允许将profileFilter设置为空：
XML：：
<Rule>
<profileFilter xsi:nil="true"/>
</Rule>
JSON：：
{"Rule":{"profileFilter":null}}