List of MyDisplay templates

GET 
https://app.connectedcooking.com/api/public/my-displays/templates

Returns a list of available MyDisplay templates that dynamic_screen feature is enabled.

warning

This API is only available if you have the ERP-API feature enabled. It is not available in the Basic-API level. See API access for more details.

Request

Query Parameters

deviceFamily number
Device Family filter for the templates.
Example: 123

Responses

200

Response Headers

x-total-count
The total number of my display templates.
Example: 69
link
Pagination links for first, last and next page.
Example: </api/public/my-displays/templates?page=1&size=20>; rel="next",</api/public/my-displays/templates?page=7&size=20>; rel="last",</api/public/my-displays/templates?page=0&size=20>; rel="first"

application/json

Schema

Schema

• Array [
idnumber

The unique id of the my display template.

namestring

The name of the my display template.

versionnumber

The version of the my display template.

groupIdnumber

The id of the group the template is assigned to.

deviceFamilyIdnumber

The id of the device family the template is assigned to.

createdBystring

The user who created the template.

createdDatestring

The date the template was created.

lastModifiedBystring

The user who last modified the template.

lastModifiedDatestring

The date the template was last modified.

• ]

Example (auto)

[
  {
    "id": 0,
    "name": "string",
    "version": 0,
    "groupId": 0,
    "deviceFamilyId": 0,
    "createdBy": "string",
    "createdDate": "string",
    "lastModifiedBy": "string",
    "lastModifiedDate": "string"
  }
]

Authorization: http

name: bearerAuthtype: httpscheme: bearerbearerFormat: JWTdescription: The `access token` of the `API client` you requested with `/access`.

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://app.connectedcooking.com/api/public/my-displays/templates");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://app.connectedcooking.com

Auth

Bearer Token

Parameters

deviceFamily — query

ResponseClear

Click the Send API Request button above and see the response here!