Skip to content
/
Retrieve Template

Message Template API (0.0.12)

APIs published in this document are subject to strict change control by RUCKUS. As far as possible, when new versions of the Public API are published, all documented API endpoints will maintain backward compatibility. When not possible, an API endpoint will be deprecated, and a replacement API or another workaround will be provided. Support for deprecated API endpoints will continue for at least six months before removal to provide API client developers sufficient time to adopt the replacement. This document will indicate when API endpoints are deprecated along with the schedule for their removal. API client developers may discover other experimental API endpoints provided by the RUCKUS cloud, not included in this API document. RUCKUS reserves the right to change these experimental APIs to API client developers without notice.

Download OpenAPI description
Download PDF
Overview
License

RUCKUS Cloud Privacy Policy

Languages
Servers
Generated server url

http://localhost:8080/

Manage Templates

Manage Templates

Operations

Retrieve All Templates in Scope

Request

Returns all templates within the given template scope.

Path
templateScopeIdstring(uuid)required

Template scope ID

Query
sizeany

Page size

pageany

The page to retrieve (starts at zero).

sortany

The field name to sort, comma seperated from the sort order (asc or desc). Sortable fields are: id, nameLocalizationKey, userProvidedName, messageTemplate, and extraFieldOneTemplate

No request payload

Responses

The list of templates within the template scope.

Bodyapplication/json
pagingobject(Page Information)

The paging information for this response.

contentArray of objects(Template)

The content list of the data.

_linksobject(Links)
Response
application/json
{
  "paging": {
    "totalCount": 0,
    "page": 0,
    "pageSize": 0,
    "pageCount": 0
  },
  "content": [
    { … }
  ],
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Retrieve Template

Request

Returns the template specified by the give id, which can be either a registration id or template id.

Path
templateScopeIdstring(uuid)required

Template Scope ID

genericTemplateIdstringrequired

Template or Registration ID

No request payload

Responses

The template

Bodyapplication/json
idstringread-only

The template ID. If the template is retrieved with a registration ID this will still be the template ID.

nameLocalizationKeystringread-only

A key which can be used to reference the name of the template.

userProvidedNamestringrequired

A user provided name for the template. If available this should be used instead of the name localization key.

messageTemplatestringrequired

The template.

extraFieldOneTemplatestring

An extra template field which can be used in conjunction with the template; used for the subject in e-mail templates.

editablebooleanread-only

True if the template was user generated and therefore can be edited.

_linksobject(Links)
Response
application/json
{
  "id": "string",
  "nameLocalizationKey": "string",
  "userProvidedName": "string",
  "messageTemplate": "string",
  "extraFieldOneTemplate": "string",
  "editable": true,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Template Scope

Retrieve information about the template scope

Operations

Variables

Retrieve variables available to templates within the given template scope.

Operations

Template Registrations

Retrieve template registrations

Operations

Registrations

Manage template registrations

Operations