Back

PUT metricvalues/{id}?tz={tz}

Update metric data.

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
id globally unique identifier Required

Guid ID of the trend value to update.
tz string

Optional parameter to set time zone information.

Body Parameters (TrendValue)

This object takes all the parameters needed to update a trend value.

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ID globally unique identifier Required on Update

ID of the Metric Data.
MetricID globally unique identifier Required on Create

ID of the metric.
Date date Required

Date of the metric data
Value decimal number Required

Value of the metric data
MetricName string ReadOnly

Name of the metric.
ArchiveID globally unique identifier ReadOnly

ID of the archive were the metric data is stored.
ArchiveName string ReadOnly

Name of the archive were the metric data is stored.
ArchiveDate date ReadOnly

Date the metric data was archived.

Request Formats

application/xml, text/xml

Sample
<TrendValue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>cf0a635d-0059-4d80-b331-f4a6489cc27d</ID>
  <MetricID>78c5aa1e-933a-4214-93f8-e2330a0d5caa</MetricID>
  <Date xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-02-15T20:44:37.347519Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </Date>
  <Value>1</Value>
</TrendValue>

application/json, text/json

Sample
{
  "ID": "cf0a635d-0059-4d80-b331-f4a6489cc27d",
  "MetricID": "78c5aa1e-933a-4214-93f8-e2330a0d5caa",
  "Date": "2025-02-15T20:44:37.347519+00:00",
  "Value": 1.0
}

Response Information

Resource Description (TrendValue)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ID globally unique identifier Required on Update

ID of the Metric Data.
MetricID globally unique identifier Required on Create

ID of the metric.
Date date Required

Date of the metric data
Value decimal number Required

Value of the metric data
MetricName string ReadOnly

Name of the metric.
ArchiveID globally unique identifier ReadOnly

ID of the archive were the metric data is stored.
ArchiveName string ReadOnly

Name of the archive were the metric data is stored.
ArchiveDate date ReadOnly

Date the metric data was archived.

Response Formats

application/xml, text/xml

Sample
<TrendValue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>5a13b1c8-5dd8-42f8-b2ae-cc8941b3be1c</ID>
  <MetricID>744c091c-b5ef-4416-b3bf-b8ca6d4f14c7</MetricID>
  <Date xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-02-15T20:44:37.3631417Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </Date>
  <Value>1</Value>
  <MetricName>sample string 1</MetricName>
  <ArchiveID>4405ef3e-0af9-4ca7-bbdd-7f6fccb51cd2</ArchiveID>
  <ArchiveName>sample string 2</ArchiveName>
  <ArchiveDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-02-15T20:44:37.3631417Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </ArchiveDate>
</TrendValue>

application/json, text/json

Sample
{
  "ID": "5a13b1c8-5dd8-42f8-b2ae-cc8941b3be1c",
  "MetricID": "744c091c-b5ef-4416-b3bf-b8ca6d4f14c7",
  "Date": "2025-02-15T20:44:37.3631417+00:00",
  "Value": 1.0,
  "MetricName": "sample string 1",
  "ArchiveID": "4405ef3e-0af9-4ca7-bbdd-7f6fccb51cd2",
  "ArchiveName": "sample string 2",
  "ArchiveDate": "2025-02-15T20:44:37.3631417+00:00"
}