io.relayr.java.api

Interface RuleTemplateApi

public interface RuleTemplateApi

Provides an API for the create of Rule Engine Rules on the base of pre made templates

Method Summary

Modifier and Type	Method and Description
rx.Observable<AppliedTemplate>	applyTemplate(TemplateParameters parameters, java.lang.String projectId, java.lang.String templateId, java.lang.String templateVersionId) Applies a given template.
rx.Observable<retrofit.client.Response>	deleteAppliedTemplate(java.lang.String userId, java.lang.String installationId) Removes a template installation.
rx.Observable<AppliedTemplate>	getAppliedTemplate(java.lang.String userId, java.lang.String installationId)
rx.Observable<java.util.List<AppliedTemplate>>	getAppliedTemplates(java.lang.String userId)
rx.Observable<TemplateInfo>	getTemplate(java.lang.String projectId, java.lang.String templateId)
rx.Observable<java.util.List<TemplateInfo>>	getTemplates(java.lang.String projectId)
rx.Observable<Template>	getTemplateVersion(java.lang.String projectId, java.lang.String templateId, java.lang.String templateVersionId)
rx.Observable<java.util.List<Template>>	getTemplateVersions(java.lang.String projectId, java.lang.String templateId)
rx.Observable<AppliedTemplate>	updateAppliedTemplate(java.lang.Object ruleInstallation, java.lang.String userId, java.lang.String installationId) Changes the properties of a rule template installation, i.e.

Method Detail

getTemplates

@GET(value="/projects/{id}/templates")
rx.Observable<java.util.List<TemplateInfo>> getTemplates(@Path(value="id")
                                                                                                java.lang.String projectId)

Parameters:

projectId -

Returns:

a list of templates which are associated with this project

getTemplate

@GET(value="/projects/{id}/templates/{templateId}")
rx.Observable<TemplateInfo> getTemplate(@Path(value="id")
                                                                                            java.lang.String projectId,
                                                                                            @Path(value="templateId")
                                                                                            java.lang.String templateId)

Parameters:

projectId -

templateId -

Returns:

detailed view on a template in a project. Also provides the latest version of this template (if it exists)

getTemplateVersions

@GET(value="/projects/{id}/templates/{templateId}/versions")
rx.Observable<java.util.List<Template>> getTemplateVersions(@Path(value="id")
                                                                                                                         java.lang.String projectId,
                                                                                                                         @Path(value="templateId")
                                                                                                                         java.lang.String templateId)

Parameters:

projectId -

templateId -

Returns:

a list of all the versions which exist for one template. This list can be empty if no version has been created yet.

getTemplateVersion

@GET(value="/projects/{id}/templates/{templateId}/versions/{templateVersionId}")
rx.Observable<Template> getTemplateVersion(@Path(value="id")
                                                                                                                            java.lang.String projectId,
                                                                                                                            @Path(value="templateId")
                                                                                                                            java.lang.String templateId,
                                                                                                                            @Path(value="templateVersionId")
                                                                                                                            java.lang.String templateVersionId)

Parameters:

projectId -

templateId -

templateVersionId -

Returns:

the details about a template version

applyTemplate

@POST(value="/projects/{id}/templates/{templateId}/versions/{templateVersionId}/apply")
rx.Observable<AppliedTemplate> applyTemplate(@Body
                                                                                                                                     TemplateParameters parameters,
                                                                                                                                     @Path(value="id")
                                                                                                                                     java.lang.String projectId,
                                                                                                                                     @Path(value="templateId")
                                                                                                                                     java.lang.String templateId,
                                                                                                                                     @Path(value="templateVersionId")
                                                                                                                                     java.lang.String templateVersionId)

Applies a given template. This means that the template is filled with the provided values and therefore a rule is created in the system.

Parameters:

projectId -

templateId -

templateVersionId -

Returns:

the created user installation.

getAppliedTemplates

@GET(value="/users/{userId}/ruletemplateinstallations")
rx.Observable<java.util.List<AppliedTemplate>> getAppliedTemplates(@Path(value="userId")
                                                                                                                           java.lang.String userId)

Parameters:

userId -

Returns:

list of all the installations of templates of a user. If the user applied a template three times, you will get three installations here.

getAppliedTemplate

@GET(value="/users/{userId}/ruletemplateinstallations/{installationId}")
rx.Observable<AppliedTemplate> getAppliedTemplate(@Path(value="userId")
                                                                                                                           java.lang.String userId,
                                                                                                                           @Path(value="installationId")
                                                                                                                           java.lang.String installationId)

deleteAppliedTemplate

@DELETE(value="/users/{userId}/ruletemplateinstallations/{installationId}")
rx.Observable<retrofit.client.Response> deleteAppliedTemplate(@Path(value="userId")
                                                                                                                                          java.lang.String userId,
                                                                                                                                          @Path(value="installationId")
                                                                                                                                          java.lang.String installationId)

Removes a template installation. This means that this instance of the template is removed.

Parameters:

userId -

installationId -

Returns:

• 204 - If the deletion was successful
• 401 - provided Authentication credentials are invalid or the user doesn't own the installation
• 404 - the provided installation doesn't exist

updateAppliedTemplate

@PATCH(value="/users/{userId}/ruletemplateinstallations/{installationId}")
rx.Observable<AppliedTemplate> updateAppliedTemplate(@Body
                                                                                                                                java.lang.Object ruleInstallation,
                                                                                                                                @Path(value="userId")
                                                                                                                                java.lang.String userId,
                                                                                                                                @Path(value="installationId")
                                                                                                                                java.lang.String installationId)

Changes the properties of a rule template installation, i.e. the name or the configuration parameters

Parameters:

userId -

installationId -