Package com.xebialabs.xlrelease.api.v1
Interface DslApi
- All Superinterfaces:
ApiService
Operations with release DSL.
-
Field Summary
Fields inherited from interface com.xebialabs.xlrelease.api.ApiService
DEFAULT_RESULTS_PER_PAGE, DEFAULT_RESULTS_PER_PAGE_STRING, DEPTH, ORDER_BY, PAGE, PAGE_IS_OFFSET, RESULTS_PER_PAGE, ROLE_IDS_DATA
-
Method Summary
Modifier and TypeMethodDescriptionexportTemplate
(Release template) Exports template as DSL.exportTemplate
(Release template, boolean asTemplate) jakarta.ws.rs.core.Response
exportTemplateToXFile
(String templateId, boolean asTemplate) Exports given template into DSL.jakarta.ws.rs.core.Response
previewExportTemplateToXFile
(String templateId, boolean asTemplate) Shows a DSL preview of a given template.default String
-
Method Details
-
serviceName
- Specified by:
serviceName
in interfaceApiService
-
previewExportTemplateToXFile
@GET @Path("/preview/{templateId:.*Release[^/]*}") @Produces("text/plain") jakarta.ws.rs.core.Response previewExportTemplateToXFile(@PathParam("templateId") String templateId, @QueryParam("exportTemplate") boolean asTemplate) Shows a DSL preview of a given template.- Parameters:
templateId
- the template identifier.asTemplate
- if true, will render as template, otherwise will render as release.- Returns:
- UTF-8 encoded DSL string
-
exportTemplateToXFile
@GET @Path("/export/{templateId:.*Release[^/]*}") @Produces("application/octet-stream") jakarta.ws.rs.core.Response exportTemplateToXFile(@PathParam("templateId") String templateId, @QueryParam("exportTemplate") boolean asTemplate) Exports given template into DSL.- Parameters:
templateId
- the template identifier.asTemplate
- if true, will render as template, otherwise will render as release.- Returns:
- a zip file with the DSL and attachments if the template contains them
-
exportTemplate
Exports template as DSL.- Parameters:
template
- template to export- Returns:
- DSL string
-
exportTemplate
-