Template management.
Create template
Create template.
The page API REST Tip does not exist.
1. Request
POST /<api-version>/templates.<format>
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
|
api-version |
x | string | - |
API version. Currently v1. |
|
format |
x | string | - |
Request/response format. Currently supported format is json. |
2. Request Body
New template attributes:
| Attribute | Required | Type | Default | Information |
|---|---|---|---|---|
| name | x | string | - | Template name |
| public | boolean | false | True if template is visible to other users. | |
| description | string | null | templates description |
The page Spacer does not exist.
3. Response Status
The page API HTTP Response - Get does not exist.
4. Response Body
The string ID of a created template.
5. Examples
Request
Response
The page API MAPI Outdated does not exist.The page API Messaging Tip does not exist.
1. Request
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client | |
|
template |
x | object | - |
templates details to create |
| →name | x | string | - | template name |
| →public | boolean | false | True if template is visible to other users. | |
| →description | string | null | template description |
2. Response
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier specified in request | |
|
result |
x | string | - |
Created template ID |
3. Example
The page API Mosquitto does not exist.
Request
Response
Get template details
Get template information by the ID.
The page API REST Tip does not exist.
1. Request
GET /<api-version>/template/<templateId>.<format>
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
|
api-version |
x | string | - |
API version. Currently v1. |
|
templateId |
x | string | - |
Template Id. |
|
format |
x | string | - |
Request/response format. Currently supported format is json. |
2. Response Status
The page API HTTP Response - Get does not exist.
3. Response Body
Template attributes:
| Attribute | Required | Type | Default | Information |
|---|---|---|---|---|
| id | x | string | - | Template Id. |
| name | x | string | - | Template name |
| public | x | boolean | - | True if template is visible to other users. |
| uses | x | int | - | Number of things using this template. |
| currentVersionId | string | null | Current released template version. | |
| description | string | null | template description |
The page Spacer does not exist.
4. Examples
Request
Response
The page API MAPI Outdated does not exist.The page API Messaging Tip does not exist.
1. Request
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client. | |
|
templateId |
x | string | - |
template id. |
2. Response
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client. | |
|
result |
object | null |
Template details. |
|
| →name | x | string | - | Template name. |
| →public | x | boolean | - | True if template is visible to other users. |
| →uses | x | int | - | Number of things using this template. |
| →currentVersionId | string | null | Current released template version. | |
| →description | string | null | Template description. |
3. Example
The page API Mosquitto does not exist.
Request
Response
Get templates
Obtain list of templates.
The page API REST Tip does not exist.
1. Request
GET /<api-version>/templates.<format>
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
|
api-version |
x | string | - |
API version. Currently v1. |
|
format |
x | string | - |
Request/response format. Currently supported format is json. |
2. Response Status
The page API HTTP Response - Get does not exist.
3. Response Body
Array with templates information:
| Attribute | Required | Type | Default | Information |
|---|---|---|---|---|
| id | x | string | - | Template Id. |
| name | x | string | - | Template name. |
| public | x | boolean | - | True if template is visible to other users. |
| uses | x | int | - | Number of things using this template. |
| currentVersionId | string | null | Current released template version. | |
| description | string | null | Template description. |
The page Spacer does not exist.
4. Examples
Request
Response
The page API MAPI Outdated does not exist.The page API Messaging Tip does not exist.
1. Request
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client |
2. Response
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client. | |
|
result |
array | null |
Array of templates. |
|
| →name | x | string | - | Template name. |
| →public | x | boolean | - | True if template is visible to other users. |
| →uses | x | int | - | Number of things using this template. |
| →currentVersionId | string | null | Current released template version. | |
| →description | string | null | Template description. |
3. Example
The page API Mosquitto does not exist.
Request
Response
Delete template
Delete template by ID.
The page API REST Tip does not exist.
1. Resource URL
DELETE /<api-version>/templates/<templateId>.<format>
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
|
api-version |
x | string | - |
API version. Currently v1. |
|
templateId |
x | string | - |
Template Id. |
|
format |
x | string | - |
Request/response format. Currently supported format is json. |
2. Response Status
The page API HTTP Response - Update does not exist.
3. Examples
Request
Response
The page API MAPI Outdated does not exist.The page API Messaging Tip does not exist.
1. Request
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier established by the client | |
|
templateId |
x | string | - |
Template Id. |
2. Response
| Attribute | Required | Type | Default | Description |
|---|---|---|---|---|
| id | string | null | Request identifier specified in request |
3. Example
The page API Mosquitto does not exist.
Request
Response
Page: Versions