Skip to content

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

Variables

Retrieve variables available to templates within the given template scope.

Operations

Template Registrations

Retrieve template registrations

Operations

Registrations

Manage template registrations

Operations

Retrieve All Registrations

Request

Returns all registrations 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 and the sort order (asc or desc) comma separated. Sortable fields are: id, templateId, usageLocalizationKey, usageDescriptionFieldOne, usageDescriptionFieldTwo

No request payload

Responses

The list of registrations within the template scope.

Bodyapplication/json
pagingobject(Page Information)

The paging information for this response.

contentArray of objects(Registration)

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 Registration

Request

Returns the registration for the given ID.

Path
templateScopeIdstring(uuid)required

Template Scope ID

registrationIdstringrequired

Registration ID

No request payload

Responses

The registration.

Bodyapplication/json
idstringread-only

The registration ID. This is any string from 5 to 255 characters.

templateIdstring(uuid)required

The ID of the template this registration references.

usageLocalizationKeystringrequired

A key which can be used by a user interface to lookup a localized description of where the referenced template is being used.

usageDescriptionFieldOnestring

A user specified string that can be placed into the localized description.

usageDescriptionFieldTwostring

A second user specified string that can be placed into the localized description.

_linksobject(Links)
Response
application/json
{
  "id": "string",
  "templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
  "usageLocalizationKey": "string",
  "usageDescriptionFieldOne": "string",
  "usageDescriptionFieldTwo": "string",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}