• Asset Management API

Asset Templates

get

List all asset templates

This endpoint retrieves a list of all asset templates.

limitstring

The maximum number of asset templates to return

startingAfterstring

The ID of the last asset template to return

vendorstring

The vendor of the asset templates to return

modelstring

The model of the asset templates to return

Responses

Response examples

A list of assets

{
  "data": {
    "hasMore": true,
    "items": [
      {
        "id": "string",
        "type": "chargingStation",
        "chargingStation": {
          "model": "string",
          "powerType": "AC_1_PHASE",
          "vendor": "string",
          "connectors": [
            {
              "id": 123.0,
              "connectionType": "CHADEMO",
              "format": "CABLE",
              "maxAmperage": 123.0,
              "maxVoltage": 123.0,
              "maxPowerWatts": 123.0
            }
          ],
          "configurationKeys": {
            "ocppUrl": "string"
          },
          "imageUrl": "string"
        }
      }
    ]
  }
}
post

Create a new asset template

This endpoint creates a new asset template. Only admins are allowed to create asset templates.

typestring

required

Enum
  • chargingStation
chargingStationobject

required

vendorstring

required

modelstring

required

powerTypestring

required

Enum
  • AC_1_PHASE
  • AC_3_PHASE
  • DC
connectorsarray

required

Responses

Request examples

{
  "type": "chargingStation",
  "chargingStation": {
    "vendor": "string",
    "model": "string",
    "powerType": "AC_1_PHASE",
    "connectors": [
      {
        "id": 123.0,
        "connectionType": "CHADEMO",
        "format": "CABLE",
        "maxAmperage": 123.0,
        "maxVoltage": 123.0,
        "maxPowerWatts": 123.0
      }
    ]
  }
}

Response examples

Success

{
  "data": {
    "id": "string",
    "type": "chargingStation",
    "chargingStation": {
      "model": "string",
      "powerType": "AC_1_PHASE",
      "vendor": "string",
      "connectors": [
        {
          "id": 123.0,
          "connectionType": "CHADEMO",
          "format": "CABLE",
          "maxAmperage": 123.0,
          "maxVoltage": 123.0,
          "maxPowerWatts": 123.0
        }
      ],
      "configurationKeys": {
        "ocppUrl": "string"
      },
      "imageUrl": "string"
    }
  }
}
get

Get an asset template by ID

This endpoint retrieves an asset template by its ID.

assetTemplateIdstring

required

The ID of the asset template to retrieve

Responses

Response examples

Success

{
  "id": "string",
  "type": "chargingStation",
  "chargingStation": {
    "model": "string",
    "powerType": "AC_1_PHASE",
    "vendor": "string",
    "connectors": [
      {
        "id": 123.0,
        "connectionType": "CHADEMO",
        "format": "CABLE",
        "maxAmperage": 123.0,
        "maxVoltage": 123.0,
        "maxPowerWatts": 123.0
      }
    ],
    "configurationKeys": {
      "ocppUrl": "string"
    },
    "imageUrl": "string"
  }
}

Was this page helpful?