Channel APIs

Get Deprecated /api/v3/channel/{channelId}

Operation: GetChannelV3 Permissions: Meters (View)

Retrieves details about a single channel


Get /api/v202105/meter/{meterId}/channel/{channelId}/version/{versionId}/udf/{udfId}/download

Operation: DownloadChannelVersionCustomFieldFileV202105 Permissions: Meters (View)

Download file for a channel version custom field


Get /api/v202101/meter/{meterId}/channel

Operation: GetMeterChannelsV202101 Permissions: Meters (View)

Retrieves all channel and channel versions linked to a meter


Post /api/v202101/meter/{meterId}/channel

Operation: CreateMeterChannelV202101 Permissions: Meters (Edit)

Creates and assigns a channel to a meter


Get /api/v202101/meter/{meterId}/channel/{channelId}

Operation: GetMeterChannelV202101 Permissions: Meters (View)

Retrieves a channel and its channel versions linked to a meter


Put /api/v202101/meter/{meterId}/channel/{channelId}

Operation: EditMeterChannelV202101 Permissions: Meters (Edit)

Updates a meter’s channel
If a channel version exists and is not passed into the request body it will continue to exist and no data will be changed.
To delete a specific channel version call DELETE meter/{meterId}/channel/{channelId}/version/{versionId}


Delete /api/v202101/meter/{meterId}/channel/{channelId}

Operation: DeleteMeterChannelV202101 Permissions: Meters (Edit)

Deletes a meter’s channel
All readings linked to this channel will also be deleted.
A channel that is part of a distribution cannot be deleted.


Post /api/v202101/meter/{meterId}/channel/{channelId}/version

Operation: CreateChannelVersionV202101 Permissions: Meters (Edit)

Create a new channel version


Put /api/v202101/meter/{meterId}/channel/{channelId}/version/{versionId}

Operation: EditChannelVersionV202101 Permissions: Meters (Edit)

Update a channel version


Delete /api/v202101/meter/{meterId}/channel/{channelId}/version/{versionId}

Operation: DeleteChannelVersionV202101 Permissions: Meters (Edit)

Delete a channel version
There must always be one version on a channel
If you try and delete the only version on a channel an exception will occur