Skip to content
/
Get Template Scope

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

Template Scope

Retrieve information about the template scope

Operations

Retrieve All Template Scopes

Request

Returns all available template scopes.

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, messageType, and nameLocalizationKey

No request payload

Responses

The list of template scopes.

Bodyapplication/json
pagingobject(Page Information)

The paging information for this response.

contentArray of objects(Template Scope)

The content list of the data.

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

Get Template Scope

Request

Retrieves the template scope for the given id.

Path
templateScopeIdstring(uuid)required

Template scope id

Query
includesArray of strings

A comma seperated list of child resources to include in the response in the format: includes={resourcePath},{resourcePath}. Where {resourcePath} must match the REST API path for that resource underneath the Template Scope. Only individual registrations are allowed. Any resource that is invalid or not found will be silently ignored. For example: includes=registrations/registration.id.1,registrations/registration.id.2

No request payload

Responses

Template scope

Bodyapplication/json
idstring(uuid)
messageTypestring
Enum"EMAIL""SMS"
nameLocalizationKeystring
defaultTemplateIdstring(uuid)
registrationsArray of objects(Registration)
_linksobject(Links)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "messageType": "EMAIL",
  "nameLocalizationKey": "string",
  "defaultTemplateId": "bee715a2-1763-4940-8b0e-39be16b372e7",
  "registrations": [
    { … }
  ],
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Variables

Retrieve variables available to templates within the given template scope.

Operations

Template Registrations

Retrieve template registrations

Operations

Registrations

Manage template registrations

Operations