Get configuration templates

x-ms-visibility: "important"

Retrieve a list of all configuration templates associated with the user.

Query Parameters

page int64

Page to be fetched. Default: 1

limit int64

Limit (No. of records per page). Max value: 100. Default: 100.

search string

Free text filter for template name.

sortKey string

Field to be used for sorting. Default: name

sortDescending boolean

Set to 'true' to sort descending based on sort key. Default: 'false'

Responses

• 200
• 400
• 401

---

List of configuration templates accessible by the user.

application/json

Schema

Example (from schema)

---

Schema

page int32
limit int32
totalRecords int32
hasNextPage boolean
hasPreviousPage boolean
items object[]
Array [
id int64
editable boolean
name string
createdAt date-time
updatedAt date-time nullable
implementations object[]
Array [
id int64
configTemplateId int64
editable boolean
manufacturer string
model string
firmwareVersion string
createdAt date-time
updatedAt date-time nullable
configTemplateName string
ocppEntries object[]
Array [
id int64
configTemplateImplementationId int64
editable boolean
key string
value string
createdAt date-time
updatedAt date-time nullable
]
]
]

{
  "page": 0,
  "limit": 0,
  "totalRecords": 0,
  "hasNextPage": true,
  "hasPreviousPage": true,
  "items": [
    {
      "id": 0,
      "editable": true,
      "name": "string",
      "createdAt": "2025-08-26T05:08:33.463Z",
      "updatedAt": "2025-08-26T05:08:33.463Z",
      "implementations": [
        {
          "id": 0,
          "configTemplateId": 0,
          "editable": true,
          "manufacturer": "string",
          "model": "string",
          "firmwareVersion": "string",
          "createdAt": "2025-08-26T05:08:33.463Z",
          "updatedAt": "2025-08-26T05:08:33.463Z",
          "configTemplateName": "string",
          "ocppEntries": [
            {
              "id": 0,
              "configTemplateImplementationId": 0,
              "editable": true,
              "key": "string",
              "value": "string",
              "createdAt": "2025-08-26T05:08:33.463Z",
              "updatedAt": "2025-08-26T05:08:33.463Z"
            }
          ]
        }
      ]
    }
  ]
}

Exception Details

application/json

Schema

Example (from schema)

---

Schema

errorCode string
message string
errorNumber int32
helpLink string

{
  "errorCode": "string",
  "message": "string",
  "errorNumber": 0,
  "helpLink": "string"
}

User not authorised

Loading...